delete_custom_vocabulary ¶

delete_custom_vocabulary(
    bot_id: Id,
    bot_version: DraftBotVersion,
    locale_id: LocaleId,
    *,
    config_overrides: Optional[LexModelsV2ClientConfig] = None,
) -> DeleteCustomVocabularyResponse

Removes a custom vocabulary from the specified locale in the specified bot.

Parameters:

bot_id (Id) –

The unique identifier of the bot to remove the custom vocabulary from.
bot_version (DraftBotVersion) –

The version of the bot to remove the custom vocabulary from.
locale_id (LocaleId) –

The locale identifier for the locale that contains the custom vocabulary to remove.

Raises:

ConflictException –

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
InternalServerException –

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

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try 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/lex_models_v2.py

def delete_custom_vocabulary(
    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,
) -> "capo_lex_models_v2.types.delete_custom_vocabulary_response.DeleteCustomVocabularyResponse":
    """<p>Removes a custom vocabulary from the specified locale in the specified bot.</p>

    Args:
        bot_id: <p>The unique identifier of the bot to remove the custom vocabulary from.</p>
        bot_version: <p>The version of the bot to remove the custom vocabulary from.</p>
        locale_id: <p>The locale identifier for the locale that contains the custom vocabulary to remove.</p>

    Raises:
        capo_lex_models_v2.errors.conflict_exception.ConflictException: <p>The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again. </p>
        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.precondition_failed_exception.PreconditionFailedException: <p>Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request 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.delete_custom_vocabulary_request.DeleteCustomVocabularyRequest]",
    ) -> OperationResponse[
        "capo_lex_models_v2.types.delete_custom_vocabulary_response.DeleteCustomVocabularyResponse"
    ]:
        import capo_lex_models_v2._operations.lex_model_building_service_v2.delete_custom_vocabulary

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteCustomVocabulary")
    )
    input_: capo_lex_models_v2.types.delete_custom_vocabulary_request.DeleteCustomVocabularyRequest = {
        "bot_id": bot_id,
        "bot_version": bot_version,
        "locale_id": locale_id,
    }

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