Skip to content

List Domain Maintenances

opensearchservice_list_domain_maintenances R Documentation

A list of maintenance actions for the domain

Description

A list of maintenance actions for the domain.

Usage

opensearchservice_list_domain_maintenances(DomainName, Action, Status,
  MaxResults, NextToken)

Arguments

DomainName

[required] The name of the domain.

Action

The name of the action.

Status

The status of the action.

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 list_domain_maintenances operation returns a nextToken, include the returned nextToken in subsequent list_domain_maintenances operations, which returns results in the next page.

Value

A list with the following syntax:

list(
  DomainMaintenances = list(
    list(
      MaintenanceId = "string",
      DomainName = "string",
      Action = "REBOOT_NODE"|"RESTART_SEARCH_PROCESS"|"RESTART_DASHBOARD",
      NodeId = "string",
      Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"TIMED_OUT",
      StatusMessage = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_domain_maintenances(
  DomainName = "string",
  Action = "REBOOT_NODE"|"RESTART_SEARCH_PROCESS"|"RESTART_DASHBOARD",
  Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"TIMED_OUT",
  MaxResults = 123,
  NextToken = "string"
)