amazonka-translate-2.0: Amazon Translate SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Translate.Types.TerminologyData

Description

 
Synopsis

Documentation

data TerminologyData Source #

The data associated with the custom terminology. For information about the custom terminology file, see Creating a Custom Terminology.

See: newTerminologyData smart constructor.

Constructors

TerminologyData' 

Fields

  • directionality :: Maybe 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 (for example, 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 or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

    When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

  • file :: Sensitive Base64

    The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

  • format :: TerminologyDataFormat

    The data format of the custom terminology.

Instances

Instances details
ToJSON TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

Generic TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

Associated Types

type Rep TerminologyData :: Type -> Type #

Show TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

NFData TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

Methods

rnf :: TerminologyData -> () #

Eq TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

Hashable TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

type Rep TerminologyData Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyData

type Rep TerminologyData = D1 ('MetaData "TerminologyData" "Amazonka.Translate.Types.TerminologyData" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "TerminologyData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directionality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Directionality)) :*: (S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Base64)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TerminologyDataFormat))))

newTerminologyData Source #

Create a value of TerminologyData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:directionality:TerminologyData', terminologyData_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 (for example, 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 or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

$sel:file:TerminologyData', terminologyData_file - The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:format:TerminologyData', terminologyData_format - The data format of the custom terminology.

terminologyData_directionality :: Lens' TerminologyData (Maybe Directionality) Source #

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 (for example, 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 or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

terminologyData_file :: Lens' TerminologyData ByteString Source #

The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

terminologyData_format :: Lens' TerminologyData TerminologyDataFormat Source #

The data format of the custom terminology.