Skip to content

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain

Description

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Usage

opensearchservice_describe_domain_change_progress(DomainName, ChangeId)

Arguments

  • DomainName

    [required] The name of the domain to get progress information for.

  • ChangeId

    The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

Value

A list with the following syntax:

list(
  ChangeProgressStatus = list(
    ChangeId = "string",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "PENDING"|"PROCESSING"|"COMPLETED"|"FAILED",
    PendingProperties = list(
      "string"
    ),
    CompletedProperties = list(
      "string"
    ),
    TotalNumberOfStages = 123,
    ChangeProgressStages = list(
      list(
        Name = "string",
        Status = "string",
        Description = "string",
        LastUpdated = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    ConfigChangeStatus = "Pending"|"Initializing"|"Validating"|"ValidationFailed"|"ApplyingChanges"|"Completed"|"PendingUserInput"|"Cancelled",
    InitiatedBy = "CUSTOMER"|"SERVICE",
    ValidationFailures = list(
      list(
        Code = "string",
        Message = "string",
        Severity = "Critical"|"Warning"
      )
    ),
    AcceptedWarnings = list(
      "string"
    )
  )
)

Request syntax

svc$describe_domain_change_progress(
  DomainName = "string",
  ChangeId = "string"
)