list_bots `async` ¶

list_bots(
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
    sort_by: Optional[BotSortBy] = None,
    filters: Optional[BotFilters] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListBotsResponse

Gets a list of available bots.

Parameters:

sort_by (Optional[BotSortBy], default: None ) –

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.
filters (Optional[BotFilters], default: None ) –

Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.
max_results (Optional[MaxResults], default: None ) –

The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.
next_token (Optional[NextToken], default: None ) –

If the response from the ListBots operation contains more results than specified in the maxResults parameter, a token is returned in the response.

Use the returned token in the nextToken parameter of a ListBots request to return the next page of results. For a complete set of results, call the ListBots operation until the nextToken returned in the response is null.

Raises:

InternalServerException –

The service encountered an unexpected condition. Try your request again.
ServiceQuotaExceededException –

You have reached a quota for your bot.
ThrottlingException –

Your request rate is too high. Reduce the frequency of requests.
ValidationException –

One of the input parameters in your request isn't valid. Check the parameters and try your request again.
UnknownServiceError –

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

Source code in docs_src/capo_lex_models_v2/_services/async_lex_models_v2.py

async def list_bots(
    self,
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
    sort_by: Optional["capo_lex_models_v2.types.bot_sort_by.BotSortBy"] = None,
    filters: Optional["capo_lex_models_v2.types.bot_filters.BotFilters"] = None,
    max_results: Optional["capo_lex_models_v2.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_lex_models_v2.types.next_token.NextToken"] = None,
) -> "capo_lex_models_v2.types.list_bots_response.ListBotsResponse":
    """<p>Gets a list of available bots.</p>

    Args:
        sort_by: <p>Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.</p>
        filters: <p>Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p>
        max_results: <p>The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.</p>
        next_token: <p>If the response from the <code>ListBots</code> operation contains more results than specified in the <code>maxResults</code> parameter, a token is returned in the response. </p> <p>Use the returned token in the <code>nextToken</code> parameter of a <code>ListBots</code> request to return the next page of results. For a complete set of results, call the <code>ListBots</code> operation until the <code>nextToken</code> returned in the response is null.</p>

    Raises:
        capo_lex_models_v2.errors.internal_server_exception.InternalServerException: <p>The service encountered an unexpected condition. Try your request again.</p>
        capo_lex_models_v2.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You have reached a quota for your bot. </p>
        capo_lex_models_v2.errors.throttling_exception.ThrottlingException: <p>Your request rate is too high. Reduce the frequency of requests.</p>
        capo_lex_models_v2.errors.validation_exception.ValidationException: <p>One of the input parameters in your request isn't valid. Check the parameters and try your request again.</p>
        capo_lex_models_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBots")
    )
    input_: capo_lex_models_v2.types.list_bots_request.ListBotsRequest = {}
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if filters is not None:
        input_["filters"] = filters
    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` ¶