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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Amazon Translate does not support batch translation of multiple source languages at once.

Synopsis

Creating a Request

data StartTextTranslationJob Source #

See: newStartTextTranslationJob smart constructor.

Constructors

StartTextTranslationJob'

Fields

jobName :: Maybe Text
The name of the batch translation job to be performed.
parallelDataNames :: Maybe [Text]
The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.
terminologyNames :: Maybe [Text]
The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.
inputDataConfig :: InputDataConfig
Specifies the format and S3 location of the input documents for the translation job.
outputDataConfig :: OutputDataConfig
Specifies the S3 folder to which your job output will be saved.
dataAccessRoleArn :: Text
The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.
sourceLanguageCode :: Text
The language code of the input language. For a list of language codes, see what-is-languages.
Amazon Translate does not automatically detect a source language during batch translation jobs.
targetLanguageCodes :: NonEmpty Text
The language code of the output language.
clientToken :: Text
A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Instances

Instances details

Eq StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods (==) :: StartTextTranslationJob -> StartTextTranslationJob -> Bool # (/=) :: StartTextTranslationJob -> StartTextTranslationJob -> Bool #
Read StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods readsPrec :: Int -> ReadS StartTextTranslationJob # readList :: ReadS [StartTextTranslationJob] # readPrec :: ReadPrec StartTextTranslationJob # readListPrec :: ReadPrec [StartTextTranslationJob] #
Show StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods showsPrec :: Int -> StartTextTranslationJob -> ShowS # show :: StartTextTranslationJob -> String # showList :: [StartTextTranslationJob] -> ShowS #
Generic StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Associated Types type Rep StartTextTranslationJob :: Type -> Type # Methods from :: StartTextTranslationJob -> Rep StartTextTranslationJob x # to :: Rep StartTextTranslationJob x -> StartTextTranslationJob #
NFData StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods rnf :: StartTextTranslationJob -> () #
Hashable StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods hashWithSalt :: Int -> StartTextTranslationJob -> Int # hash :: StartTextTranslationJob -> Int #
ToJSON StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods toJSON :: StartTextTranslationJob -> Value # toEncoding :: StartTextTranslationJob -> Encoding # toJSONList :: [StartTextTranslationJob] -> Value # toEncodingList :: [StartTextTranslationJob] -> Encoding #
AWSRequest StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Associated Types type AWSResponse StartTextTranslationJob # Methods request :: StartTextTranslationJob -> Request StartTextTranslationJob # response :: MonadResource m => Logger -> Service -> Proxy StartTextTranslationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartTextTranslationJob))) #
ToHeaders StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods toHeaders :: StartTextTranslationJob -> [Header] #
ToPath StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods toPath :: StartTextTranslationJob -> ByteString #
ToQuery StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods toQuery :: StartTextTranslationJob -> QueryString #
type Rep StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type Rep StartTextTranslationJob = D1 ('MetaData "StartTextTranslationJob" "Amazonka.Translate.StartTextTranslationJob" "libZSservicesZSamazonka-translateZSamazonka-translate" 'False) (C1 ('MetaCons "StartTextTranslationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parallelDataNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "terminologyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig))) :: ((S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig) :: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sourceLanguageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "targetLanguageCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type AWSResponse StartTextTranslationJob = StartTextTranslationJobResponse

newStartTextTranslationJob Source #

Arguments

:: InputDataConfig	`$sel:inputDataConfig:StartTextTranslationJob'`
-> OutputDataConfig	`$sel:outputDataConfig:StartTextTranslationJob'`
-> Text	`$sel:dataAccessRoleArn:StartTextTranslationJob'`
-> Text	`$sel:sourceLanguageCode:StartTextTranslationJob'`
-> NonEmpty Text	`$sel:targetLanguageCodes:StartTextTranslationJob'`
-> Text	`$sel:clientToken:StartTextTranslationJob'`
-> StartTextTranslationJob

Create a value of StartTextTranslationJob 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:jobName:StartTextTranslationJob', startTextTranslationJob_jobName - The name of the batch translation job to be performed.

$sel:parallelDataNames:StartTextTranslationJob', startTextTranslationJob_parallelDataNames - The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.

$sel:terminologyNames:StartTextTranslationJob', startTextTranslationJob_terminologyNames - The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

$sel:inputDataConfig:StartTextTranslationJob', startTextTranslationJob_inputDataConfig - Specifies the format and S3 location of the input documents for the translation job.

$sel:outputDataConfig:StartTextTranslationJob', startTextTranslationJob_outputDataConfig - Specifies the S3 folder to which your job output will be saved.

$sel:dataAccessRoleArn:StartTextTranslationJob', startTextTranslationJob_dataAccessRoleArn - The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

$sel:sourceLanguageCode:StartTextTranslationJob', startTextTranslationJob_sourceLanguageCode - The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

$sel:targetLanguageCodes:StartTextTranslationJob', startTextTranslationJob_targetLanguageCodes - The language code of the output language.

$sel:clientToken:StartTextTranslationJob', startTextTranslationJob_clientToken - A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Request Lenses

startTextTranslationJob_jobName :: Lens' StartTextTranslationJob (Maybe Text) Source #

The name of the batch translation job to be performed.

startTextTranslationJob_parallelDataNames :: Lens' StartTextTranslationJob (Maybe [Text]) Source #

The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.

startTextTranslationJob_terminologyNames :: Lens' StartTextTranslationJob (Maybe [Text]) Source #

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

startTextTranslationJob_inputDataConfig :: Lens' StartTextTranslationJob InputDataConfig Source #

Specifies the format and S3 location of the input documents for the translation job.

startTextTranslationJob_outputDataConfig :: Lens' StartTextTranslationJob OutputDataConfig Source #

Specifies the S3 folder to which your job output will be saved.

startTextTranslationJob_dataAccessRoleArn :: Lens' StartTextTranslationJob Text Source #

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

startTextTranslationJob_sourceLanguageCode :: Lens' StartTextTranslationJob Text Source #

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

startTextTranslationJob_targetLanguageCodes :: Lens' StartTextTranslationJob (NonEmpty Text) Source #

The language code of the output language.

startTextTranslationJob_clientToken :: Lens' StartTextTranslationJob Text Source #

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

Destructuring the Response

data StartTextTranslationJobResponse Source #

See: newStartTextTranslationJobResponse smart constructor.

Constructors

StartTextTranslationJobResponse'

Fields

jobId :: Maybe Text
The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
jobStatus :: Maybe JobStatus
The status of the job. Possible values include:
- SUBMITTED - The job has been received and is queued for processing.
- IN_PROGRESS - Amazon Translate is processing the job.
- COMPLETED - The job was successfully completed and the output is available.
- COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
- FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
- STOP_REQUESTED - The user who started the job has requested that it be stopped.
- STOPPED - The job has been stopped.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods (==) :: StartTextTranslationJobResponse -> StartTextTranslationJobResponse -> Bool # (/=) :: StartTextTranslationJobResponse -> StartTextTranslationJobResponse -> Bool #
Read StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods readsPrec :: Int -> ReadS StartTextTranslationJobResponse # readList :: ReadS [StartTextTranslationJobResponse] # readPrec :: ReadPrec StartTextTranslationJobResponse # readListPrec :: ReadPrec [StartTextTranslationJobResponse] #
Show StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods showsPrec :: Int -> StartTextTranslationJobResponse -> ShowS # show :: StartTextTranslationJobResponse -> String # showList :: [StartTextTranslationJobResponse] -> ShowS #
Generic StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Associated Types type Rep StartTextTranslationJobResponse :: Type -> Type # Methods from :: StartTextTranslationJobResponse -> Rep StartTextTranslationJobResponse x # to :: Rep StartTextTranslationJobResponse x -> StartTextTranslationJobResponse #
NFData StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods rnf :: StartTextTranslationJobResponse -> () #
type Rep StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type Rep StartTextTranslationJobResponse = D1 ('MetaData "StartTextTranslationJobResponse" "Amazonka.Translate.StartTextTranslationJob" "libZSservicesZSamazonka-translateZSamazonka-translate" 'False) (C1 ('MetaCons "StartTextTranslationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartTextTranslationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartTextTranslationJobResponse'`
-> StartTextTranslationJobResponse

Create a value of StartTextTranslationJobResponse 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:StartTextTranslationJobResponse', startTextTranslationJobResponse_jobId - The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

$sel:jobStatus:StartTextTranslationJobResponse', startTextTranslationJobResponse_jobStatus - The status of the job. Possible values include:

SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Translate is processing the job.
COMPLETED - The job was successfully completed and the output is available.
COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
STOP_REQUESTED - The user who started the job has requested that it be stopped.
STOPPED - The job has been stopped.

$sel:httpStatus:StartTextTranslationJobResponse', startTextTranslationJobResponse_httpStatus - The response's http status code.

Response Lenses

startTextTranslationJobResponse_jobId :: Lens' StartTextTranslationJobResponse (Maybe Text) Source #

The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.

startTextTranslationJobResponse_jobStatus :: Lens' StartTextTranslationJobResponse (Maybe JobStatus) Source #

The status of the job. Possible values include:

SUBMITTED - The job has been received and is queued for processing.
IN_PROGRESS - Amazon Translate is processing the job.
COMPLETED - The job was successfully completed and the output is available.
COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
STOP_REQUESTED - The user who started the job has requested that it be stopped.
STOPPED - The job has been stopped.

startTextTranslationJobResponse_httpStatus :: Lens' StartTextTranslationJobResponse Int Source #

The response's http status code.