Skip to content

list_domain_names async

list_domain_names(
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    engine_type: Optional[EngineType] = None,
) -> ListDomainNamesResponse

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Parameters:

  • engine_type (Optional[EngineType], default: None ) –

    Filters the output by domain engine type.

Raises:

Source code in docs_src/capo_opensearch/_services/async_open_search.py
async def list_domain_names(
    self,
    *,
    config_overrides: Optional[AsyncOpenSearchClientConfig] = None,
    engine_type: Optional["capo_opensearch.types.engine_type.EngineType"] = None,
) -> "capo_opensearch.types.list_domain_names_response.ListDomainNamesResponse":
    """<p>Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.</p>

    Args:
        engine_type: <p>Filters the output by domain engine type.</p>

    Raises:
        capo_opensearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</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.list_domain_names_request.ListDomainNamesRequest]",
    ) -> AsyncOperationResponse[
        "capo_opensearch.types.list_domain_names_response.ListDomainNamesResponse"
    ]:
        import capo_opensearch._operations.amazon_open_search_service.list_domain_names

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomainNames")
    )
    input_: capo_opensearch.types.list_domain_names_request.ListDomainNamesRequest = {}
    if engine_type is not None:
        input_["engine_type"] = engine_type

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