Skip to content

Start Service Software Update

opensearchservice_start_service_software_update R Documentation

Schedules a service software update for an Amazon OpenSearch Service domain

Description

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Usage

opensearchservice_start_service_software_update(DomainName, ScheduleAt,
  DesiredStartTime)

Arguments

DomainName

[required] The name of the domain that you want to update to the latest service software.

ScheduleAt

When to start the service software update.

  • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

  • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

  • OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

DesiredStartTime

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

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$start_service_software_update(
  DomainName = "string",
  ScheduleAt = "NOW"|"TIMESTAMP"|"OFF_PEAK_WINDOW",
  DesiredStartTime = 123
)