[ aws . es ]

describe-domain-auto-tunes

Description

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-domain-auto-tunes
--domain-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

Specifies the domain name for which you want Auto-Tune action details.

--max-results (integer)

Set this value to limit the number of results returned. If not specified, defaults to 100.

--next-token (string)

NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

AutoTunes -> (list)

Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

(structure)

Specifies Auto-Tune type and Auto-Tune action details.

AutoTuneType -> (string)

Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails -> (structure)

Specifies details of the Auto-Tune action. See the Developer Guide for more information.

ScheduledAutoTuneDetails -> (structure)

Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

Date -> (timestamp)

Specifies timestamp for the Auto-Tune action scheduled for the domain.

ActionType -> (string)

Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

Action -> (string)

Specifies Auto-Tune action description.

Severity -> (string)

Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.

NextToken -> (string)

Specifies an identifier to allow retrieval of paginated results.