Skip to content

GetVocabularyResponse

Source code in docs_src/capo_transcribe/types/get_vocabulary_response.py
class GetVocabularyResponse(TypedDict, closed=True):
    vocabulary_name: NotRequired["capo_transcribe.types.vocabulary_name.VocabularyName"]
    """<p>The name of the custom vocabulary you requested information about.</p>"""
    language_code: NotRequired["capo_transcribe.types.language_code.LanguageCode"]
    """<p>The language code you selected for your custom vocabulary.</p>"""
    vocabulary_state: NotRequired[
        "capo_transcribe.types.vocabulary_state.VocabularyState"
    ]
    """<p>The processing state of your custom vocabulary. If the state is <code>READY</code>, you can use the custom vocabulary in a <code>StartTranscriptionJob</code> request.</p>"""
    last_modified_time: NotRequired["capo_transcribe.types.date_time.DateTime"]
    """<p>The date and time the specified custom vocabulary was last modified.</p> <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May 4, 2022.</p>"""
    failure_reason: NotRequired["capo_transcribe.types.failure_reason.FailureReason"]
    """<p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code> contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>"""
    download_uri: NotRequired["capo_transcribe.types.uri.Uri"]
    """<p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.</p>"""
    data_access_role_arn: NotRequired[
        "capo_transcribe.types.data_access_role_arn.DataAccessRoleArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the IAM role used to access the Amazon S3 bucket that contains your input files and, if applicable, the KMS key specified in <code>EncryptionConfiguration</code>.</p>"""
    encryption_configuration: NotRequired[
        "capo_transcribe.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration used for your custom vocabulary.</p>"""

data_access_role_arn instance-attribute

data_access_role_arn: NotRequired[DataAccessRoleArn]

The Amazon Resource Name (ARN) of the IAM role used to access the Amazon S3 bucket that contains your input files and, if applicable, the KMS key specified in EncryptionConfiguration.

download_uri instance-attribute

download_uri: NotRequired[Uri]

The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration used for your custom vocabulary.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If VocabularyState is FAILED, FailureReason contains information about why the custom vocabulary request failed. See also: Common Errors.

language_code instance-attribute

language_code: NotRequired[LanguageCode]

The language code you selected for your custom vocabulary.

last_modified_time instance-attribute

last_modified_time: NotRequired[DateTime]

The date and time the specified custom vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

vocabulary_name instance-attribute

vocabulary_name: NotRequired[VocabularyName]

The name of the custom vocabulary you requested information about.

vocabulary_state instance-attribute

vocabulary_state: NotRequired[VocabularyState]

The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.