AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]

get-upgrade-history

Description

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

See also: AWS API Documentation

Synopsis

  get-upgrade-history
--domain-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--domain-name (string)

The name of an existing domain.

--max-results (integer)

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

--next-token (string)

If your initial GetUpgradeHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

UpgradeHistories -> (list)

A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

(structure)

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

UpgradeName -> (string)

A string that describes the upgrade.

StartTimestamp -> (timestamp)

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

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 each step performed as part of a specific upgrade or upgrade eligibility check.

(structure)

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

UpgradeStep -> (string)

One of three steps that 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)

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.