ListVersions
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
Request Syntax
GET /2021-01-01/opensearch/versions?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- 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
ListVersions
operation returns anextToken
, you can include the returnednextToken
in subsequentListVersions
operations, which returns results in the next page.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Versions": [ "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.
- NextToken
-
When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.Type: String
- Versions
-
A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
Type: Array of strings
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}$
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 missing or invalid input fields.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: