Cancel Service Software Update

opensearchservice_cancel_service_software_update

R Documentation

Cancels a scheduled service software update for an Amazon OpenSearch Service domain¶

Description¶

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Usage¶

opensearchservice_cancel_service_software_update(DomainName)

Arguments¶

DomainName: [required] Name of the OpenSearch Service domain that you want to cancel the service software update on.

Value¶

A list with the following syntax:

list(
  ServiceSoftwareOptions = list(
    CurrentVersion = "string",
    NewVersion = "string",
    UpdateAvailable = TRUE|FALSE,
    Cancellable = TRUE|FALSE,
    UpdateStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE",
    Description = "string",
    AutomatedUpdateDate = as.POSIXct(
      "2015-01-01"
    ),
    OptionalDeployment = TRUE|FALSE
  )
)

Request syntax¶

svc$cancel_service_software_update(
  DomainName = "string"
)