domain_auto_tunes

Creates, updates, deletes, gets or lists a domain_auto_tunes resource.

Overview

Name	domain_auto_tunes
Type	Resource
Id	aws.es.domain_auto_tunes

Fields

The following fields are returned by SELECT queries:

describe_domain_auto_tunes

Name	Datatype	Description
auto_tunes	array	Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.
next_token	string	Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_auto_tunes	select	domain_name, region	maxResults, nextToken	Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	Specifies the domain name for which you want Auto-Tune action details.
region	string	AWS region (default: us-east-1)
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.

SELECT examples

describe_domain_auto_tunes

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

SELECT
auto_tunes,
next_token
FROM aws.es.domain_auto_tunes
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;