get_vocabulary ¶

get_vocabulary(
    vocabulary_name: VocabularyName,
    *,
    config_overrides: Optional[TranscribeClientConfig] = None,
) -> GetVocabularyResponse

Provides information about the specified custom vocabulary.

To view the status of the specified custom vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your custom vocabulary failed.

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

Parameters:

vocabulary_name (VocabularyName) –

The name of the custom vocabulary you want information about. Custom vocabulary 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

def get_vocabulary(
    self,
    vocabulary_name: "capo_transcribe.types.vocabulary_name.VocabularyName",
    *,
    config_overrides: Optional[TranscribeClientConfig] = None,
) -> "capo_transcribe.types.get_vocabulary_response.GetVocabularyResponse":
    """<p>Provides information about the specified custom vocabulary.</p> <p>To view the status of the specified custom vocabulary, check the <code>VocabularyState</code> field. If the status is <code>READY</code>, your custom vocabulary is available to use. If the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why your custom vocabulary failed.</p> <p>To get a list of your custom vocabularies, use the operation.</p>

    Args:
        vocabulary_name: <p>The name of the custom vocabulary you want information about. Custom vocabulary 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.get_vocabulary_request.GetVocabularyRequest]",
    ) -> OperationResponse[
        "capo_transcribe.types.get_vocabulary_response.GetVocabularyResponse"
    ]:
        import capo_transcribe._operations.transcribe.get_vocabulary

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetVocabulary")
    )
    input_: capo_transcribe.types.get_vocabulary_request.GetVocabularyRequest = {
        "vocabulary_name": vocabulary_name
    }

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