Get Upgrade History

opensearchservice_get_upgrade_history

R Documentation

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

Description¶

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

Usage¶

opensearchservice_get_upgrade_history(DomainName, MaxResults, NextToken)

Arguments¶

DomainName

[required] The name of an existing domain.

MaxResults

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

NextToken

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

Value¶

A list with the following syntax:

list(
  UpgradeHistories = list(
    list(
      UpgradeName = "string",
      StartTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      UpgradeStatus = "IN_PROGRESS"|"SUCCEEDED"|"SUCCEEDED_WITH_ISSUES"|"FAILED",
      StepsList = list(
        list(
          UpgradeStep = "PRE_UPGRADE_CHECK"|"SNAPSHOT"|"UPGRADE",
          UpgradeStepStatus = "IN_PROGRESS"|"SUCCEEDED"|"SUCCEEDED_WITH_ISSUES"|"FAILED",
          Issues = list(
            "string"
          ),
          ProgressPercent = 123.0
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_upgrade_history(
  DomainName = "string",
  MaxResults = 123,
  NextToken = "string"
)