Skip to content

delete_vocabulary_filter 

delete_vocabulary_filter(
    vocabulary_filter_name: VocabularyFilterName,
    *,
    config_overrides: Optional[TranscribeClientConfig] = None,
) -> None

Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using VocabularyFilterName. Custom vocabulary filter names are case sensitive.

Parameters:

  • vocabulary_filter_name (VocabularyFilterName) –

    The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.

Raises:

  • BadRequestException –

    Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as IN PROGRESS). See the exception message field for more information.

  • InternalFailureException –

    There was an internal error. Check the error message, correct the issue, and try your request again.

  • LimitExceededException –

    You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.

  • NotFoundException –

    We can't find the requested resource. Check that the specified name is correct and try your request again.

  • UnknownServiceError –

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

Source code in docs_src/capo_transcribe/_services/transcribe.py 
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
def delete_vocabulary_filter(
    self,
    vocabulary_filter_name: "capo_transcribe.types.vocabulary_filter_name.VocabularyFilterName",
    *,
    config_overrides: Optional[TranscribeClientConfig] = None,
) -> None:
    """<p>Deletes a custom vocabulary filter. To use this operation, specify the name of the custom vocabulary filter you want to delete using <code>VocabularyFilterName</code>. Custom vocabulary filter names are case sensitive.</p>

    Args:
        vocabulary_filter_name: <p>The name of the custom vocabulary filter you want to delete. Custom vocabulary filter names are case sensitive.</p>

    Raises:
        capo_transcribe.errors.bad_request_exception.BadRequestException: <p>Your request didn't pass one or more validation tests. This can occur when the entity you're trying to delete doesn't exist or if it's in a non-terminal state (such as <code>IN PROGRESS</code>). See the exception message field for more information.</p>
        capo_transcribe.errors.internal_failure_exception.InternalFailureException: <p>There was an internal error. Check the error message, correct the issue, and try your request again.</p>
        capo_transcribe.errors.limit_exceeded_exception.LimitExceededException: <p>You've either sent too many requests or your input file is too long. Wait before retrying your request, or use a smaller file and try your request again.</p>
        capo_transcribe.errors.not_found_exception.NotFoundException: <p>We can't find the requested resource. Check that the specified name is correct and try your request again.</p>
        capo_transcribe.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_transcribe.types.delete_vocabulary_filter_request.DeleteVocabularyFilterRequest]",
    ) -> OperationResponse[None]:
        import capo_transcribe._operations.transcribe.delete_vocabulary_filter

        output, http_response = (
            capo_transcribe._operations.transcribe.delete_vocabulary_filter.delete_vocabulary_filter(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteVocabularyFilter")
    )
    input_: capo_transcribe.types.delete_vocabulary_filter_request.DeleteVocabularyFilterRequest = {
        "vocabulary_filter_name": vocabulary_filter_name
    }

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