domain_auto_tunes

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

Overview

Name	domain_auto_tunes
Type	Resource
Id	aws.opensearch.domain_auto_tunes

Fields

The following fields are returned by SELECT queries:

describe_domain_auto_tunes

Name	Datatype	Description
auto_tunes	array	The list of setting adjustments that Auto-Tune has made to the domain.
next_token	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.

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	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.

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	Name of the domain that you want Auto-Tune details about.
region	string	AWS region (default: us-east-1)
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.

SELECT examples

describe_domain_auto_tunes

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.

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