Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . opensearch ]

describe-domain-auto-tunes

Description

Provides scheduled Auto-Tune action details for the 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 <value>]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

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. Used for pagination.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AutoTunes -> (list)

The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.

(structure)

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

AutoTuneType -> (string)

Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

AutoTuneDetails -> (structure)

Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

ScheduledAutoTuneDetails -> (structure)

Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

Date -> (timestamp)

The timestamp of the Auto-Tune action scheduled for the domain.

ActionType -> (string)

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

Action -> (string)

The Auto-Tune action description.

Severity -> (string)

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

NextToken -> (string)

An identifier to allow retrieval of paginated results.