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.TerminologyProperties

Description

 
Synopsis

Documentation

data TerminologyProperties Source #

The properties of the custom terminology.

See: newTerminologyProperties smart constructor.

Constructors

TerminologyProperties' 

Fields

  • arn :: Maybe Text

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

  • createdAt :: Maybe POSIX

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

  • description :: Maybe Text

    The description of the custom terminology properties.

  • 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 (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.
  • encryptionKey :: Maybe EncryptionKey

    The encryption key for the custom terminology.

  • format :: Maybe TerminologyDataFormat

    The format of the custom terminology input file.

  • lastUpdatedAt :: Maybe POSIX

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

  • message :: Maybe Text

    Additional information from Amazon Translate about the terminology resource.

  • name :: Maybe Text

    The name of the custom terminology.

  • sizeBytes :: Maybe Int

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

  • skippedTermCount :: Maybe Int

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

  • sourceLanguageCode :: Maybe Text

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

  • targetLanguageCodes :: Maybe [Text]

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

  • termCount :: Maybe Int

    The number of terms included in the custom terminology.

Instances

Instances details
FromJSON TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

Generic TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

Associated Types

type Rep TerminologyProperties :: Type -> Type #

Read TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

Show TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

NFData TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

Methods

rnf :: TerminologyProperties -> () #

Eq TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

Hashable TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

type Rep TerminologyProperties Source # 
Instance details

Defined in Amazonka.Translate.Types.TerminologyProperties

type Rep TerminologyProperties = D1 ('MetaData "TerminologyProperties" "Amazonka.Translate.Types.TerminologyProperties" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" 'False) (C1 ('MetaCons "TerminologyProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "directionality") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Directionality)) :*: S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionKey))) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TerminologyDataFormat)) :*: S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: ((S1 ('MetaSel ('Just "skippedTermCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "sourceLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targetLanguageCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "termCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))))

newTerminologyProperties :: TerminologyProperties Source #

Create a value of TerminologyProperties 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:arn:TerminologyProperties', terminologyProperties_arn - The Amazon Resource Name (ARN) of the custom terminology.

$sel:createdAt:TerminologyProperties', terminologyProperties_createdAt - The time at which the custom terminology was created, based on the timestamp.

$sel:description:TerminologyProperties', terminologyProperties_description - The description of the custom terminology properties.

$sel:directionality:TerminologyProperties', terminologyProperties_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.

$sel:encryptionKey:TerminologyProperties', terminologyProperties_encryptionKey - The encryption key for the custom terminology.

$sel:format:TerminologyProperties', terminologyProperties_format - The format of the custom terminology input file.

$sel:lastUpdatedAt:TerminologyProperties', terminologyProperties_lastUpdatedAt - The time at which the custom terminology was last update, based on the timestamp.

$sel:message:TerminologyProperties', terminologyProperties_message - Additional information from Amazon Translate about the terminology resource.

$sel:name:TerminologyProperties', terminologyProperties_name - The name of the custom terminology.

$sel:sizeBytes:TerminologyProperties', terminologyProperties_sizeBytes - The size of the file used when importing a custom terminology.

$sel:skippedTermCount:TerminologyProperties', terminologyProperties_skippedTermCount - The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

$sel:sourceLanguageCode:TerminologyProperties', terminologyProperties_sourceLanguageCode - The language code for the source text of the translation request for which the custom terminology is being used.

$sel:targetLanguageCodes:TerminologyProperties', terminologyProperties_targetLanguageCodes - The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

$sel:termCount:TerminologyProperties', terminologyProperties_termCount - The number of terms included in the custom terminology.

terminologyProperties_arn :: Lens' TerminologyProperties (Maybe Text) Source #

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

terminologyProperties_createdAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #

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

terminologyProperties_description :: Lens' TerminologyProperties (Maybe Text) Source #

The description of the custom terminology properties.

terminologyProperties_directionality :: Lens' TerminologyProperties (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 (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.

terminologyProperties_format :: Lens' TerminologyProperties (Maybe TerminologyDataFormat) Source #

The format of the custom terminology input file.

terminologyProperties_lastUpdatedAt :: Lens' TerminologyProperties (Maybe UTCTime) Source #

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

terminologyProperties_message :: Lens' TerminologyProperties (Maybe Text) Source #

Additional information from Amazon Translate about the terminology resource.

terminologyProperties_name :: Lens' TerminologyProperties (Maybe Text) Source #

The name of the custom terminology.

terminologyProperties_sizeBytes :: Lens' TerminologyProperties (Maybe Int) Source #

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

terminologyProperties_skippedTermCount :: Lens' TerminologyProperties (Maybe Int) Source #

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

terminologyProperties_sourceLanguageCode :: Lens' TerminologyProperties (Maybe Text) Source #

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

terminologyProperties_targetLanguageCodes :: Lens' TerminologyProperties (Maybe [Text]) Source #

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

terminologyProperties_termCount :: Lens' TerminologyProperties (Maybe Int) Source #

The number of terms included in the custom terminology.