Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
Parameters:
-
domain_name
(DomainName)
–
Specifies the domain name for which you want Auto-Tune action details.
-
max_results
(Optional[MaxResults], default:
None
)
–
Set this value to limit the number of results returned. If not specified, defaults to 100.
-
next_token
(Optional[NextToken], default:
None
)
–
NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
Raises:
-
BaseException
–
An error occurred while processing the request.
-
InternalException
–
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
-
ResourceNotFoundException
–
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
-
ValidationException
–
An exception for missing / invalid input fields. Gives http status code of 400.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_elasticsearch_service/_services/elasticsearch_service.py
| def describe_domain_auto_tunes(
self,
domain_name: "capo_elasticsearch_service.types.domain_name.DomainName",
*,
config_overrides: Optional[ElasticsearchServiceClientConfig] = None,
max_results: Optional[
"capo_elasticsearch_service.types.max_results.MaxResults"
] = None,
next_token: Optional[
"capo_elasticsearch_service.types.next_token.NextToken"
] = None,
) -> "capo_elasticsearch_service.types.describe_domain_auto_tunes_response.DescribeDomainAutoTunesResponse":
"""<p>Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.</p>
Args:
domain_name: <p>Specifies the domain name for which you want Auto-Tune action details.</p>
max_results: <p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>
next_token: <p>NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>
Raises:
capo_elasticsearch_service.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
capo_elasticsearch_service.errors.internal_exception.InternalException: <p>The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.</p>
capo_elasticsearch_service.errors.resource_not_found_exception.ResourceNotFoundException: <p>An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.</p>
capo_elasticsearch_service.errors.validation_exception.ValidationException: <p>An exception for missing / invalid input fields. Gives http status code of 400.</p>
capo_elasticsearch_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_elasticsearch_service.types.describe_domain_auto_tunes_request.DescribeDomainAutoTunesRequest]",
) -> OperationResponse[
"capo_elasticsearch_service.types.describe_domain_auto_tunes_response.DescribeDomainAutoTunesResponse"
]:
import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_domain_auto_tunes
output, http_response = (
capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_domain_auto_tunes.describe_domain_auto_tunes(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDomainAutoTunes")
)
input_: capo_elasticsearch_service.types.describe_domain_auto_tunes_request.DescribeDomainAutoTunesRequest = {
"domain_name": domain_name
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|