list_custom_vocabulary_items ¶

def list_custom_vocabulary_items(
    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[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_custom_vocabulary_items_response.ListCustomVocabularyItemsResponse":
    """<p>Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.</p>

    Args:
        bot_id: <p>The identifier of the version of the bot associated with this custom vocabulary.</p>
        bot_version: <p>The bot version of the bot to the list custom vocabulary request.</p>
        locale_id: <p>The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).</p>
        max_results: <p>The maximum number of items returned by the list operation.</p>
        next_token: <p>The nextToken identifier to the list custom vocabulary request.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_lex_models_v2.types.list_custom_vocabulary_items_request.ListCustomVocabularyItemsRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.list_custom_vocabulary_items_response.ListCustomVocabularyItemsResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.list_custom_vocabulary_items

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCustomVocabularyItems")
    )
    input_: capo_lex_models_v2.types.list_custom_vocabulary_items_request.ListCustomVocabularyItemsRequest = {
        "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