Skip to content

list_bot_resource_generations async

list_bot_resource_generations(
    bot_id: Id,
    bot_version: BotVersion,
    locale_id: LocaleId,
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
    sort_by: Optional[GenerationSortBy] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListBotResourceGenerationsResponse

Lists the generation requests made for a bot locale.

Parameters:

  • bot_id (Id) –

    The unique identifier of the bot whose generation requests you want to view.

  • bot_version (BotVersion) –

    The version of the bot whose generation requests you want to view.

  • locale_id (LocaleId) –

    The locale of the bot whose generation requests you want to view.

  • sort_by (Optional[GenerationSortBy], default: None ) –

    An object containing information about the attribute and the method by which to sort the results

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

    The maximum number of results to return in the response.

  • next_token (Optional[NextToken], default: None ) –

    If the total number of results is greater than the number specified in the maxResults, the response returns a token in the nextToken field. Use this token when making a request to return the next batch of results.

Raises:

  • InternalServerException –

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

  • ResourceNotFoundException –

    You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

  • 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_bot_resource_generations(
    self,
    bot_id: "capo_lex_models_v2.types.id.Id",
    bot_version: "capo_lex_models_v2.types.bot_version.BotVersion",
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId",
    *,
    config_overrides: Optional[AsyncLexModelsV2ClientConfig] = None,
    sort_by: Optional[
        "capo_lex_models_v2.types.generation_sort_by.GenerationSortBy"
    ] = 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_bot_resource_generations_response.ListBotResourceGenerationsResponse":
    """<p>Lists the generation requests made for a bot locale.</p>

    Args:
        bot_id: <p>The unique identifier of the bot whose generation requests you want to view.</p>
        bot_version: <p>The version of the bot whose generation requests you want to view.</p>
        locale_id: <p>The locale of the bot whose generation requests you want to view.</p>
        sort_by: <p>An object containing information about the attribute and the method by which to sort the results</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        next_token: <p>If the total number of results is greater than the number specified in the <code>maxResults</code>, the response returns a token in the <code>nextToken</code> field. Use this token when making a request to return the next batch of results.</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.resource_not_found_exception.ResourceNotFoundException: <p>You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.</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_bot_resource_generations_request.ListBotResourceGenerationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_lex_models_v2.types.list_bot_resource_generations_response.ListBotResourceGenerationsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_resource_generations

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBotResourceGenerations")
    )
    input_: capo_lex_models_v2.types.list_bot_resource_generations_request.ListBotResourceGenerationsRequest = {
        "bot_id": bot_id,
        "bot_version": bot_version,
        "locale_id": locale_id,
    }
    if sort_by is not None:
        input_["sort_by"] = sort_by
    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