describe_domains `async` ¶

describe_domains(
    domain_names: DomainNameList,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> DescribeDomainsResponse

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Parameters:

domain_names (DomainNameList) –

Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.

Raises:

BaseException –

An error occurred while processing the request.
InternalException –

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

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

The service returned an error code this client does not model.

Source code in docs_src/capo_opensearch/_services/async_open_search.py

async def describe_domains(
    self,
    domain_names: "capo_opensearch.types.domain_name_list.DomainNameList",
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
) -> "capo_opensearch.types.describe_domains_response.DescribeDomainsResponse":
    """<p>Returns domain configuration information about the specified Amazon OpenSearch Service domains.</p>

    Args:
        domain_names: <p>Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_opensearch.errors.internal_exception.InternalException: <p>Request processing failed because of an unknown error, exception, or internal failure.</p>
        capo_opensearch.errors.validation_exception.ValidationException: <p>An exception for accessing or deleting a resource that doesn't exist.</p>
        capo_opensearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_opensearch.types.describe_domains_request.DescribeDomainsRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.describe_domains_response.DescribeDomainsResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.describe_domains

        (
            output,
            http_response,
        ) = await capo_opensearch._operations.amazon_open_search_service.describe_domains.async_describe_domains(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDomains")
    )
    input_: capo_opensearch.types.describe_domains_request.DescribeDomainsRequest = {
        "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

describe_domains async ¶

describe_domains `async` ¶