Skip to content
AWS for Query.Farm

aws.opensearch.get_upgrade_history

Example SQL Queries

SELECT * FROM
aws.opensearch.get_upgrade_history
WHERE
"domain_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of an existing domain.

VARCHAR
max_results Input Column

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

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

upgrade_histories

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

STRUCT(
    "upgrade_name" VARCHAR,
    "start_timestamp" TIMESTAMP_S,
    "upgrade_status" VARCHAR,
    "steps_list" STRUCT(
        "upgrade_step" VARCHAR,
        "upgrade_step_status" VARCHAR,
        "issues" VARCHAR[],
        "progress_percent" DOUBLE
    )[]
)[]
Show child fields
upgrade_histories[]
Show child fields
upgrade_histories[].start_timestamp

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

upgrade_histories[].steps_list[]
Show child fields
upgrade_histories[].steps_list[].issues[]
upgrade_histories[].steps_list[].progress_percent

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

upgrade_histories[].steps_list[].upgrade_step

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

  • PreUpgradeCheck

  • Snapshot

  • Upgrade

upgrade_histories[].steps_list[].upgrade_step_status

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

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed

upgrade_histories[].upgrade_name

A string that describes the upgrade.

upgrade_histories[].upgrade_status

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

  • In Progress

  • Succeeded

  • Succeeded with Issues

  • Failed