Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Translate.Types.TextTranslationJobProperties

Description

Synopsis

Documentation

data TextTranslationJobProperties Source #

Provides information about a translation job.

See: newTextTranslationJobProperties smart constructor.

Constructors

TextTranslationJobProperties'

Fields

jobId :: Maybe Text
The ID of the translation job.
targetLanguageCodes :: Maybe (NonEmpty Text)
The language code of the language of the target text. The language must be a language supported by Amazon Translate.
jobName :: Maybe Text
The user-defined name of the translation job.
submittedTime :: Maybe POSIX
The time at which the translation job was submitted.
inputDataConfig :: Maybe InputDataConfig
The input configuration properties that were specified when the job was requested.
parallelDataNames :: Maybe [Text]
A list containing the names of the parallel data resources applied to the translation job.
terminologyNames :: Maybe [Text]
A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
sourceLanguageCode :: Maybe Text
The language code of the language of the source text. The language must be a language supported by Amazon Translate.
endTime :: Maybe POSIX
The time at which the translation job ended.
outputDataConfig :: Maybe OutputDataConfig
The output configuration properties that were specified when the job was requested.
jobDetails :: Maybe JobDetails
The number of documents successfully and unsuccessfully processed during the translation job.
dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
jobStatus :: Maybe JobStatus
The status of the translation job.
message :: Maybe Text
An explanation of any errors that may have occured during the translation job.

Instances

Instances details

Eq TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods (==) :: TextTranslationJobProperties -> TextTranslationJobProperties -> Bool # (/=) :: TextTranslationJobProperties -> TextTranslationJobProperties -> Bool #
Read TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods readsPrec :: Int -> ReadS TextTranslationJobProperties # readList :: ReadS [TextTranslationJobProperties] # readPrec :: ReadPrec TextTranslationJobProperties # readListPrec :: ReadPrec [TextTranslationJobProperties] #
Show TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods showsPrec :: Int -> TextTranslationJobProperties -> ShowS # show :: TextTranslationJobProperties -> String # showList :: [TextTranslationJobProperties] -> ShowS #
Generic TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Associated Types type Rep TextTranslationJobProperties :: Type -> Type # Methods from :: TextTranslationJobProperties -> Rep TextTranslationJobProperties x # to :: Rep TextTranslationJobProperties x -> TextTranslationJobProperties #
NFData TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods rnf :: TextTranslationJobProperties -> () #
Hashable TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods hashWithSalt :: Int -> TextTranslationJobProperties -> Int # hash :: TextTranslationJobProperties -> Int #
FromJSON TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties Methods parseJSON :: Value -> Parser TextTranslationJobProperties # parseJSONList :: Value -> Parser [TextTranslationJobProperties] #
type Rep TextTranslationJobProperties Source #
Instance details Defined in Amazonka.Translate.Types.TextTranslationJobProperties type Rep TextTranslationJobProperties = D1 ('MetaData "TextTranslationJobProperties" "Amazonka.Translate.Types.TextTranslationJobProperties" "libZSservicesZSamazonka-translateZSamazonka-translate" 'False) (C1 ('MetaCons "TextTranslationJobProperties'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "targetLanguageCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "submittedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDataConfig))) :: (S1 ('MetaSel ('Just "parallelDataNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "terminologyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "sourceLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputDataConfig)))) :: ((S1 ('MetaSel ('Just "jobDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobDetails)) :: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newTextTranslationJobProperties :: TextTranslationJobProperties Source #

Create a value of TextTranslationJobProperties 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:jobId:TextTranslationJobProperties', textTranslationJobProperties_jobId - The ID of the translation job.

$sel:targetLanguageCodes:TextTranslationJobProperties', textTranslationJobProperties_targetLanguageCodes - The language code of the language of the target text. The language must be a language supported by Amazon Translate.

$sel:jobName:TextTranslationJobProperties', textTranslationJobProperties_jobName - The user-defined name of the translation job.

$sel:submittedTime:TextTranslationJobProperties', textTranslationJobProperties_submittedTime - The time at which the translation job was submitted.

$sel:inputDataConfig:TextTranslationJobProperties', textTranslationJobProperties_inputDataConfig - The input configuration properties that were specified when the job was requested.

$sel:parallelDataNames:TextTranslationJobProperties', textTranslationJobProperties_parallelDataNames - A list containing the names of the parallel data resources applied to the translation job.

$sel:terminologyNames:TextTranslationJobProperties', textTranslationJobProperties_terminologyNames - A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

$sel:sourceLanguageCode:TextTranslationJobProperties', textTranslationJobProperties_sourceLanguageCode - The language code of the language of the source text. The language must be a language supported by Amazon Translate.

$sel:endTime:TextTranslationJobProperties', textTranslationJobProperties_endTime - The time at which the translation job ended.

$sel:outputDataConfig:TextTranslationJobProperties', textTranslationJobProperties_outputDataConfig - The output configuration properties that were specified when the job was requested.

$sel:jobDetails:TextTranslationJobProperties', textTranslationJobProperties_jobDetails - The number of documents successfully and unsuccessfully processed during the translation job.

$sel:dataAccessRoleArn:TextTranslationJobProperties', textTranslationJobProperties_dataAccessRoleArn - The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

$sel:jobStatus:TextTranslationJobProperties', textTranslationJobProperties_jobStatus - The status of the translation job.

$sel:message:TextTranslationJobProperties', textTranslationJobProperties_message - An explanation of any errors that may have occured during the translation job.

textTranslationJobProperties_jobId :: Lens' TextTranslationJobProperties (Maybe Text) Source #

The ID of the translation job.

textTranslationJobProperties_targetLanguageCodes :: Lens' TextTranslationJobProperties (Maybe (NonEmpty Text)) Source #

The language code of the language of the target text. The language must be a language supported by Amazon Translate.

textTranslationJobProperties_jobName :: Lens' TextTranslationJobProperties (Maybe Text) Source #

The user-defined name of the translation job.

textTranslationJobProperties_submittedTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #

The time at which the translation job was submitted.

textTranslationJobProperties_inputDataConfig :: Lens' TextTranslationJobProperties (Maybe InputDataConfig) Source #

The input configuration properties that were specified when the job was requested.

textTranslationJobProperties_parallelDataNames :: Lens' TextTranslationJobProperties (Maybe [Text]) Source #

A list containing the names of the parallel data resources applied to the translation job.

textTranslationJobProperties_terminologyNames :: Lens' TextTranslationJobProperties (Maybe [Text]) Source #

A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

textTranslationJobProperties_sourceLanguageCode :: Lens' TextTranslationJobProperties (Maybe Text) Source #

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

textTranslationJobProperties_endTime :: Lens' TextTranslationJobProperties (Maybe UTCTime) Source #

The time at which the translation job ended.

textTranslationJobProperties_outputDataConfig :: Lens' TextTranslationJobProperties (Maybe OutputDataConfig) Source #

The output configuration properties that were specified when the job was requested.

textTranslationJobProperties_jobDetails :: Lens' TextTranslationJobProperties (Maybe JobDetails) Source #

The number of documents successfully and unsuccessfully processed during the translation job.

textTranslationJobProperties_dataAccessRoleArn :: Lens' TextTranslationJobProperties (Maybe Text) Source #

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

textTranslationJobProperties_jobStatus :: Lens' TextTranslationJobProperties (Maybe JobStatus) Source #

The status of the translation job.

textTranslationJobProperties_message :: Lens' TextTranslationJobProperties (Maybe Text) Source #

An explanation of any errors that may have occured during the translation job.