Skip to content

TerminologyProperties

Source code in docs_src/capo_translate/types/terminology_properties.py
class TerminologyProperties(TypedDict, closed=True):
    name: NotRequired["capo_translate.types.resource_name.ResourceName"]
    """<p>The name of the custom terminology.</p>"""
    description: NotRequired["capo_translate.types.description.Description"]
    """<p>The description of the custom terminology properties.</p>"""
    arn: NotRequired["capo_translate.types.terminology_arn.TerminologyArn"]
    """<p> The Amazon Resource Name (ARN) of the custom terminology. </p>"""
    source_language_code: NotRequired[
        "capo_translate.types.language_code_string.LanguageCodeString"
    ]
    """<p>The language code for the source text of the translation request for which the custom terminology is being used.</p>"""
    target_language_codes: NotRequired[
        "capo_translate.types.language_code_string_list.LanguageCodeStringList"
    ]
    """<p>The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.</p>"""
    encryption_key: NotRequired["capo_translate.types.encryption_key.EncryptionKey"]
    """<p>The encryption key for the custom terminology.</p>"""
    size_bytes: NotRequired["capo_translate.types.integer.Integer"]
    """<p>The size of the file used when importing a custom terminology.</p>"""
    term_count: NotRequired["capo_translate.types.integer.Integer"]
    """<p>The number of terms included in the custom terminology.</p>"""
    created_at: NotRequired["capo_translate.types.timestamp.Timestamp"]
    """<p>The time at which the custom terminology was created, based on the timestamp.</p>"""
    last_updated_at: NotRequired["capo_translate.types.timestamp.Timestamp"]
    """<p>The time at which the custom terminology was last update, based on the timestamp.</p>"""
    directionality: NotRequired["capo_translate.types.directionality.Directionality"]
    """<p>The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional). </p> <dl> <dt>UNI</dt> <dd> <p>The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.</p> </dd> <dt>MULTI</dt> <dd> <p>Any language in the terminology resource can be the source language.</p> </dd> </dl>"""
    message: NotRequired[
        "capo_translate.types.unbounded_length_string.UnboundedLengthString"
    ]
    """<p>Additional information from Amazon Translate about the terminology resource.</p>"""
    skipped_term_count: NotRequired["capo_translate.types.integer.Integer"]
    """<p>The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.</p>"""
    format: NotRequired[
        "capo_translate.types.terminology_data_format.TerminologyDataFormat"
    ]
    """<p>The format of the custom terminology input file.</p>"""

arn instance-attribute

arn: NotRequired[TerminologyArn]

The Amazon Resource Name (ARN) of the custom terminology.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The time at which the custom terminology was created, based on the timestamp.

description instance-attribute

description: NotRequired[Description]

The description of the custom terminology properties.

directionality instance-attribute

directionality: NotRequired[Directionality]

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

MULTI

Any language in the terminology resource can be the source language.

encryption_key instance-attribute

encryption_key: NotRequired[EncryptionKey]

The encryption key for the custom terminology.

format instance-attribute

format: NotRequired[TerminologyDataFormat]

The format of the custom terminology input file.

last_updated_at instance-attribute

last_updated_at: NotRequired[Timestamp]

The time at which the custom terminology was last update, based on the timestamp.

message instance-attribute

message: NotRequired[UnboundedLengthString]

Additional information from Amazon Translate about the terminology resource.

name instance-attribute

name: NotRequired[ResourceName]

The name of the custom terminology.

size_bytes instance-attribute

size_bytes: NotRequired[Integer]

The size of the file used when importing a custom terminology.

skipped_term_count instance-attribute

skipped_term_count: NotRequired[Integer]

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

source_language_code instance-attribute

source_language_code: NotRequired[LanguageCodeString]

The language code for the source text of the translation request for which the custom terminology is being used.

target_language_codes instance-attribute

target_language_codes: NotRequired[LanguageCodeStringList]

The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

term_count instance-attribute

term_count: NotRequired[Integer]

The number of terms included in the custom terminology.