ElasticsearchService / Client / get_compatible_elasticsearch_versions

get_compatible_elasticsearch_versions#

ElasticsearchService.Client.get_compatible_elasticsearch_versions(**kwargs)#

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

Request Syntax

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

Parameters:

DomainName (string) – The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –

Container for response returned by GetCompatibleElasticsearchVersions operation.
- CompatibleElasticsearchVersions (list) –
  
  A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.
  - (dict) –
    
    A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.
    - SourceVersion (string) –
      
      The current version of Elasticsearch on which a domain is.
    - TargetVersions (list) –
      
      List of supported elastic search versions.
      - (string) –

Exceptions

ElasticsearchService.Client.exceptions.BaseException
ElasticsearchService.Client.exceptions.ResourceNotFoundException
ElasticsearchService.Client.exceptions.DisabledOperationException
ElasticsearchService.Client.exceptions.ValidationException
ElasticsearchService.Client.exceptions.InternalException