OpenSearchService / Client / describe_domain_auto_tunes

describe_domain_auto_tunes

OpenSearchService.Client.describe_domain_auto_tunes(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DomainName (string) –

  [REQUIRED]

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

• MaxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

• NextToken (string) – If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

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 a DescribeDomainAutoTunes request.

  • AutoTunes (list) –

    The list of setting adjustments that Auto-Tune has made to the domain.

    • (dict) –

      Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

      • AutoTuneType (string) –

        The type of Auto-Tune action.

      • AutoTuneDetails (dict) –

        Details about an Auto-Tune action.

        • ScheduledAutoTuneDetails (dict) –

          Container for details about a scheduled Auto-Tune action.

          • Date (datetime) –

            The date and time when the Auto-Tune action is scheduled for the domain.

          • ActionType (string) –

            The type of Auto-Tune action.

          • Action (string) –

            A description of the Auto-Tune action.

          • Severity (string) –

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

  • NextToken (string) –

    When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Exceptions

• OpenSearchService.Client.exceptions.BaseException

• OpenSearchService.Client.exceptions.InternalException

• OpenSearchService.Client.exceptions.ResourceNotFoundException

• OpenSearchService.Client.exceptions.ValidationException