[ aws . opensearch ]

get-upgrade-history

Description

Retrieves the complete history of the last 10 upgrades performed on the domain.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-upgrade-history
--domain-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The name of an 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).

--max-results (integer)

Set this value to limit the number of results returned.

--next-token (string)

Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

UpgradeHistories -> (list)

A list of `` UpgradeHistory `` objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the `` GetUpgradeHistoryResponse `` object.

(structure)

History of the last 10 upgrades and upgrade eligibility checks.

UpgradeName -> (string)

A string that briefly describes the upgrade.

StartTimestamp -> (timestamp)

UTC timestamp at which the upgrade API call was made in “yyyy-MM-ddTHH:mm:ssZ” format.

UpgradeStatus -> (string)

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

StepsList -> (list)

A list of `` UpgradeStepItem `` s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.

(structure)

Represents a single step of the upgrade or upgrade eligibility check workflow.

UpgradeStep -> (string)

One of three steps an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck

• Snapshot

• Upgrade

UpgradeStepStatus -> (string)

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

Issues -> (list)

A list of strings containing detailed information about the errors encountered in a particular step.

(string)

ProgressPercent -> (double)

The floating point value representing the progress percentage of a particular step.

NextToken -> (string)

Pagination token that needs to be supplied to the next call to get the next page of results.