Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListInstanceTypeDetails

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

Request Syntax


GET /2021-01-01/opensearch/instanceTypeDetails/EngineVersion?domainName=DomainName&instanceType=InstanceType&maxResults=MaxResults&nextToken=NextToken&retrieveAZs=RetrieveAZs HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DomainName

The name of the domain.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

EngineVersion

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

Length Constraints: Minimum length of 14. Maximum length of 18.

Pattern: ^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$

Required: Yes

InstanceType

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

Length Constraints: Minimum length of 10. Maximum length of 40.

Pattern: ^.*\..*\.search$

MaxResults

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

Valid Range: Maximum value of 100.

NextToken

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

RetrieveAZs

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "InstanceTypeDetails": [ 
      { 
         "AdvancedSecurityEnabled": boolean,
         "AppLogsEnabled": boolean,
         "AvailabilityZones": [ "string" ],
         "CognitoEnabled": boolean,
         "EncryptionEnabled": boolean,
         "InstanceRole": [ "string" ],
         "InstanceType": "string",
         "WarmEnabled": boolean
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InstanceTypeDetails

Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

Type: Array of InstanceTypeDetails objects

NextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400