upgrade_elasticsearch_domain

ElasticsearchService.Client.upgrade_elasticsearch_domain(**kwargs)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

See also: AWS API Documentation

Request Syntax

response = client.upgrade_elasticsearch_domain(
    DomainName='string',
    TargetVersion='string',
    PerformCheckOnly=True|False
)

Parameters

• DomainName (string) --

  [REQUIRED]

  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).

• TargetVersion (string) --

  [REQUIRED]

  The version of Elasticsearch that you intend to upgrade the domain to.

• PerformCheckOnly (boolean) -- This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

Return type

dict

Returns

Response Syntax

{
    'DomainName': 'string',
    'TargetVersion': 'string',
    'PerformCheckOnly': True|False,
    'ChangeProgressDetails': {
        'ChangeId': 'string',
        'Message': 'string'
    }
}

Response Structure

• (dict) --

  Container for response returned by UpgradeElasticsearchDomain operation.

  • 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).

  • TargetVersion (string) --

    The version of Elasticsearch that you intend to upgrade the domain to.

  • PerformCheckOnly (boolean) --

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

  • ChangeProgressDetails (dict) --

    Specifies change details of the domain configuration change.

    • ChangeId (string) --

      The unique change identifier associated with a specific domain configuration change.

    • Message (string) --

      Contains an optional message associated with the domain configuration change.

Exceptions

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