Class GetCompatibleVersionsCommandProtected

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Example

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, GetCompatibleVersionsCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, GetCompatibleVersionsCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // GetCompatibleVersionsRequest
  DomainName: "STRING_VALUE",
};
const command = new GetCompatibleVersionsCommand(input);
const response = await client.send(command);
// { // GetCompatibleVersionsResponse
//   CompatibleVersions: [ // CompatibleVersionsList
//     { // CompatibleVersionsMap
//       SourceVersion: "STRING_VALUE",
//       TargetVersions: [ // VersionList
//         "STRING_VALUE",
//       ],
//     },
//   ],
// };

Param

GetCompatibleVersionsCommandInput

Returns

GetCompatibleVersionsCommandOutput

See

• GetCompatibleVersionsCommandInput for command's input shape.
• GetCompatibleVersionsCommandOutput for command's response shape.
• config for OpenSearchClient's config shape.

Throws

BaseException (client fault)

An error occurred while processing the request.

Throws

DisabledOperationException (client fault)

An error occured because the client wanted to access an unsupported operation.

Throws

InternalException (server fault)

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

Throws

ResourceNotFoundException (client fault)

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

Throws

ValidationException (client fault)

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

Throws

OpenSearchServiceException

Base exception class for all service exceptions from OpenSearch service.