get_compatible_versions

OpenSearchService.Client.get_compatible_versions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_compatible_versions(
    DomainName='string'
)

Parameters

DomainName (string) -- The name of an existing domain. Provide this parameter to limit the results to a single domain.

Return type

dict

Returns

Response Syntax

{
    'CompatibleVersions': [
        {
            'SourceVersion': 'string',
            'TargetVersions': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) --

  Container for the response returned by the GetCompatibleVersions operation.

  • CompatibleVersions (list) --

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

    • (dict) --

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

      • SourceVersion (string) --

        The current version that the OpenSearch Service domain is running.

      • TargetVersions (list) --

        The possible versions that you can upgrade the domain to.

        • (string) --

Exceptions

• OpenSearchService.Client.exceptions.BaseException
• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.DisabledOperationException
• OpenSearchService.Client.exceptions.ValidationException
• OpenSearchService.Client.exceptions.InternalException