[ aws . es ]

get-upgrade-status

Description

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-upgrade-status
--domain-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--domain-name (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).

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

UpgradeStep -> (string)

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

• PreUpgradeCheck

• Snapshot

• Upgrade

StepStatus -> (string)

One of 4 statuses that a step can go through returned as part of the `` GetUpgradeStatusResponse `` object. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

UpgradeName -> (string)

A string that describes the update briefly