list_bot_recommendations ¶

def list_bot_recommendations(
    self,
    bot_id: "capo_lex_models_v2.types.id.Id",
    bot_version: "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion",
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId",
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = 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_recommendations_response.ListBotRecommendationsResponse":
    """<p>Get a list of bot recommendations that meet the specified criteria.</p>

    Args:
        bot_id: <p>The unique identifier of the bot that contains the bot recommendation list.</p>
        bot_version: <p>The version of the bot that contains the bot recommendation list.</p>
        locale_id: <p>The identifier of the language and locale of the bot recommendation list.</p>
        max_results: <p>The maximum number of bot recommendations to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.</p>
        next_token: <p>If the response from the ListBotRecommendation operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page 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.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.list_bot_recommendations_request.ListBotRecommendationsRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.list_bot_recommendations_response.ListBotRecommendationsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_recommendations

        output, http_response = (
            capo_lex_models_v2._operations.lex_model_building_service_v2.list_bot_recommendations.list_bot_recommendations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListBotRecommendations")
    )
    input_: capo_lex_models_v2.types.list_bot_recommendations_request.ListBotRecommendationsRequest = {
        "bot_id": bot_id,
        "bot_version": bot_version,
        "locale_id": locale_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output