list_domains `async` ¶

list_domains(
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListDomainsResponse

Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.

Parameters:

max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return per page.
next_token (Optional[NextToken], default: None ) –

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

We couldn't process your request because of an issue with the server. Try again later.
ThrottlingException –

The rate has been exceeded for this API. Please try again after a few minutes.
ValidationException –

The request isn't valid. Check the syntax and try again.
UnknownServiceError –

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

Source code in docs_src/capo_connectcases/_services/async_connect_cases.py

async def list_domains(
    self,
    *,
    config_overrides: Optional[AsyncConnectCasesClientConfig] = None,
    max_results: Optional["capo_connectcases.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_connectcases.types.next_token.NextToken"] = None,
) -> "capo_connectcases.types.list_domains_response.ListDomainsResponse":
    """<p>Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain.</p>

    Args:
        max_results: <p>The maximum number of results to return per page.</p>
        next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>

    Raises:
        capo_connectcases.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_connectcases.errors.internal_server_exception.InternalServerException: <p>We couldn't process your request because of an issue with the server. Try again later.</p>
        capo_connectcases.errors.throttling_exception.ThrottlingException: <p>The rate has been exceeded for this API. Please try again after a few minutes.</p>
        capo_connectcases.errors.validation_exception.ValidationException: <p>The request isn't valid. Check the syntax and try again.</p>
        capo_connectcases.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connectcases.types.list_domains_request.ListDomainsRequest]",
    ) -> AsyncOperationResponse[
        "capo_connectcases.types.list_domains_response.ListDomainsResponse"
    ]:
        import capo_connectcases._operations.amazon_connect_cases.list_domains

        (
            output,
            http_response,
        ) = await capo_connectcases._operations.amazon_connect_cases.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_connectcases.types.list_domains_request.ListDomainsRequest = {}
    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` ¶