get_vocabulary_filter `async` ¶

get_vocabulary_filter(
    vocabulary_filter_name: VocabularyFilterName,
    *,
    config_overrides: Optional[AsyncTranscribeClientConfig] = None,
) -> GetVocabularyFilterResponse

Provides information about the specified custom vocabulary filter.

To get a list of your custom vocabulary filters, use the operation.

Parameters:

vocabulary_filter_name (VocabularyFilterName) –

The name of the custom vocabulary filter you want information about. 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/async_transcribe.py

async def get_vocabulary_filter(
    self,
    vocabulary_filter_name: "capo_transcribe.types.vocabulary_filter_name.VocabularyFilterName",
    *,
    config_overrides: Optional[AsyncTranscribeClientConfig] = None,
) -> "capo_transcribe.types.get_vocabulary_filter_response.GetVocabularyFilterResponse":
    """<p>Provides information about the specified custom vocabulary filter.</p> <p>To get a list of your custom vocabulary filters, use the operation.</p>

    Args:
        vocabulary_filter_name: <p>The name of the custom vocabulary filter you want information about. 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transcribe.types.get_vocabulary_filter_request.GetVocabularyFilterRequest]",
    ) -> AsyncOperationResponse[
        "capo_transcribe.types.get_vocabulary_filter_response.GetVocabularyFilterResponse"
    ]:
        import capo_transcribe._operations.transcribe.get_vocabulary_filter

        (
            output,
            http_response,
        ) = await capo_transcribe._operations.transcribe.get_vocabulary_filter.async_get_vocabulary_filter(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetVocabularyFilter")
    )
    input_: capo_transcribe.types.get_vocabulary_filter_request.GetVocabularyFilterRequest = {
        "vocabulary_filter_name": vocabulary_filter_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_vocabulary_filter async ¶

get_vocabulary_filter `async` ¶