list_domains `async` ¶

list_domains(
    *,
    config_overrides: Optional[AsyncConnectHealthClientConfig] = None,
    status: Optional[DomainStatus] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListDomainsOutput

Lists Domains for a given account.

Parameters:

status (Optional[DomainStatus], default: None ) –

Filter by Domain status.
max_results (Optional[int], default: None ) –

Maximum number of results to return.
next_token (Optional[str], default: None ) –

Token for pagination.

Raises:

UnknownServiceError –

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

Source code in docs_src/capo_connecthealth/_services/async_connect_health.py

async def list_domains(
    self,
    *,
    config_overrides: Optional[AsyncConnectHealthClientConfig] = None,
    status: Optional["capo_connecthealth.types.domain_status.DomainStatus"] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_connecthealth.types.list_domains_output.ListDomainsOutput":
    """<p>Lists Domains for a given account.</p>

    Args:
        status: <p>Filter by Domain status.</p>
        max_results: <p>Maximum number of results to return.</p>
        next_token: <p>Token for pagination.</p>

    Raises:
        capo_connecthealth.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connecthealth.types.list_domains_input.ListDomainsInput]",
    ) -> AsyncOperationResponse[
        "capo_connecthealth.types.list_domains_output.ListDomainsOutput"
    ]:
        import capo_connecthealth._operations.connect_health.list_domains

        (
            output,
            http_response,
        ) = await capo_connecthealth._operations.connect_health.list_domains.async_list_domains(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDomains")
    )
    input_: capo_connecthealth.types.list_domains_input.ListDomainsInput = {}
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_domains async ¶

list_domains `async` ¶