list_bots `async` ¶

list_bots(
    account_id: NonEmptyString,
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
    max_results: Optional[ResultMax] = None,
    next_token: Optional[String] = None,
) -> ListBotsResponse

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

Parameters:

account_id (NonEmptyString) –

The Amazon Chime account ID.
max_results (Optional[ResultMax], default: None ) –

The maximum number of results to return in a single call. The default is 10.
next_token (Optional[String], default: None ) –

The token to use to retrieve the next page of results.

Raises:

BadRequestException –

The input parameters don't match the service's restrictions.
ForbiddenException –

The client is permanently forbidden from making the request.
NotFoundException –

One or more of the resources in the request does not exist in the system.
ServiceFailureException –

The service encountered an unexpected error.
ServiceUnavailableException –

The service is currently unavailable.
ThrottledClientException –

The client exceeded its request rate limit.
UnauthorizedClientException –

The client is not currently authorized to make the request.
UnknownServiceError –

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

Source code in docs_src/capo_chime/_services/async_chime.py

async def list_bots(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncChimeClientConfig] = None,
    max_results: Optional["capo_chime.types.result_max.ResultMax"] = None,
    next_token: Optional["capo_chime.types.string.String"] = None,
) -> "capo_chime.types.list_bots_response.ListBotsResponse":
    """<p>Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        max_results: <p>The maximum number of results to return in a single call. The default is 10.</p>
        next_token: <p>The token to use to retrieve the next page of results.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_chime.types.list_bots_request.ListBotsRequest]",
    ) -> AsyncOperationResponse[
        "capo_chime.types.list_bots_response.ListBotsResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.list_bots

        (
            output,
            http_response,
        ) = await capo_chime._operations.uc_buzz_console_service.list_bots.async_list_bots(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime.types.list_bots_response.ListBotsResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.list_bots_response

        return capo_chime.types.list_bots_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBots", redact_output=_redact_output)
    )
    input_: capo_chime.types.list_bots_request.ListBotsRequest = {
        "account_id": account_id
    }
    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_bots async ¶

list_bots `async` ¶