Skip to content

Describe Domain Auto Tunes

opensearchservice_describe_domain_auto_tunes R Documentation

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain

Description

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Usage

opensearchservice_describe_domain_auto_tunes(DomainName, MaxResults,
  NextToken)

Arguments

DomainName

[required] Name of the domain that you want Auto-Tune details about.

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

Value

A list with the following syntax:

list(
  AutoTunes = list(
    list(
      AutoTuneType = "SCHEDULED_ACTION",
      AutoTuneDetails = list(
        ScheduledAutoTuneDetails = list(
          Date = as.POSIXct(
            "2015-01-01"
          ),
          ActionType = "JVM_HEAP_SIZE_TUNING"|"JVM_YOUNG_GEN_TUNING",
          Action = "string",
          Severity = "LOW"|"MEDIUM"|"HIGH"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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