Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeDomainAutoTunes

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.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/autoTunes HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

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

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Type: Integer

Valid Range: Maximum value of 100.

Required: No

NextToken

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.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AutoTunes": [ 
      { 
         "AutoTuneDetails": { 
            "ScheduledAutoTuneDetails": { 
               "Action": "string",
               "ActionType": "string",
               "Date": number,
               "Severity": "string"
            }
         },
         "AutoTuneType": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AutoTunes

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

Type: Array of AutoTune objects

NextToken

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.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BaseException

An error occurred while processing the request.

HTTP Status Code: 400

InternalException

Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409

ValidationException

An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 400