Skip to content

describe_elasticsearch_domains async

describe_elasticsearch_domains(
    domain_names: DomainNameList,
    *,
    config_overrides: Optional[AsyncElasticsearchServiceClientConfig] = None,
) -> DescribeElasticsearchDomainsResponse

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Parameters:

  • domain_names (DomainNameList) –

    The Elasticsearch domains for which you want information.

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.

  • 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/async_elasticsearch_service.py
async def describe_elasticsearch_domains(
    self,
    domain_names: "capo_elasticsearch_service.types.domain_name_list.DomainNameList",
    *,
    config_overrides: Optional[AsyncElasticsearchServiceClientConfig] = None,
) -> "capo_elasticsearch_service.types.describe_elasticsearch_domains_response.DescribeElasticsearchDomainsResponse":
    """<p>Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.</p>

    Args:
        domain_names: <p>The Elasticsearch domains for which you want information.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_elasticsearch_service.types.describe_elasticsearch_domains_request.DescribeElasticsearchDomainsRequest]",
    ) -> AsyncOperationResponse[
        "capo_elasticsearch_service.types.describe_elasticsearch_domains_response.DescribeElasticsearchDomainsResponse"
    ]:
        import capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_elasticsearch_domains

        (
            output,
            http_response,
        ) = await capo_elasticsearch_service._operations.amazon_elasticsearch_service2015.describe_elasticsearch_domains.async_describe_elasticsearch_domains(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeElasticsearchDomains")
    )
    input_: capo_elasticsearch_service.types.describe_elasticsearch_domains_request.DescribeElasticsearchDomainsRequest = {
        "domain_names": domain_names
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output