ElasticsearchService / Client / describe_domain_auto_tunes

describe_domain_auto_tunes

ElasticsearchService.Client.describe_domain_auto_tunes(**kwargs)

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

Request Syntax

response = client.describe_domain_auto_tunes(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• DomainName (string) –

  [REQUIRED]

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

• MaxResults (integer) – Set this value to limit the number of results returned. If not specified, defaults to 100.

• NextToken (string) – NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Return type:

dict

Returns:

Response Syntax

{
    'AutoTunes': [
        {
            'AutoTuneType': 'SCHEDULED_ACTION',
            'AutoTuneDetails': {
                'ScheduledAutoTuneDetails': {
                    'Date': datetime(2015, 1, 1),
                    'ActionType': 'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
                    'Action': 'string',
                    'Severity': 'LOW'|'MEDIUM'|'HIGH'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The result of DescribeDomainAutoTunes request. See the Developer Guide for more information.

  • AutoTunes (list) –

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

    • (dict) –

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

      • AutoTuneType (string) –

        Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

      • AutoTuneDetails (dict) –

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

        • ScheduledAutoTuneDetails (dict) –

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

          • Date (datetime) –

            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.

Exceptions

• ElasticsearchService.Client.exceptions.BaseException

• ElasticsearchService.Client.exceptions.InternalException

• ElasticsearchService.Client.exceptions.ResourceNotFoundException

• ElasticsearchService.Client.exceptions.ValidationException