Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Translate.StartTextTranslationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.

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

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 name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.
When you add parallel data to a translation job, you create an /Active Custom Translation/ job.
This parameter accepts only one parallel data resource.
Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.
For a list of available parallel data resources, use the ListParallelData operation.
For more information, see Customizing your translations with parallel data.
settings :: Maybe TranslationSettings
Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.
terminologyNames :: Maybe [Text]
The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.
This parameter accepts only one custom terminology resource.
If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.
For a list of available custom terminology resources, use the ListTerminologies operation.
For more information, see Custom terminology.
inputDataConfig :: InputDataConfig
Specifies the format and 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 information, see Identity and access management .
sourceLanguageCode :: Text
The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.
targetLanguageCodes :: NonEmpty Text
The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.
Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.
clientToken :: Text
A unique identifier for the request. This token is generated for you when using the Amazon Translate SDK.

Instances

Instances details

ToJSON StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods toJSON :: StartTextTranslationJob -> Value # toEncoding :: StartTextTranslationJob -> Encoding # toJSONList :: [StartTextTranslationJob] -> Value # toEncodingList :: [StartTextTranslationJob] -> Encoding #
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 #
AWSRequest StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Associated Types type AWSResponse StartTextTranslationJob # Methods request :: (Service -> Service) -> StartTextTranslationJob -> Request StartTextTranslationJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartTextTranslationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartTextTranslationJob))) #
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 #
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 #
NFData StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods rnf :: StartTextTranslationJob -> () #
Eq StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods (==) :: StartTextTranslationJob -> StartTextTranslationJob -> Bool # (/=) :: StartTextTranslationJob -> StartTextTranslationJob -> Bool #
Hashable StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods hashWithSalt :: Int -> StartTextTranslationJob -> Int # hash :: StartTextTranslationJob -> Int #
type AWSResponse StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type AWSResponse StartTextTranslationJob = StartTextTranslationJobResponse
type Rep StartTextTranslationJob Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type Rep StartTextTranslationJob = D1 ('MetaData "StartTextTranslationJob" "Amazonka.Translate.StartTextTranslationJob" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" '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 "settings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranslationSettings)) :: (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))))))

newStartTextTranslationJob Source #

Arguments

:: InputDataConfig	`StartTextTranslationJob`
-> OutputDataConfig	`StartTextTranslationJob`
-> Text	`StartTextTranslationJob`
-> Text	`StartTextTranslationJob`
-> NonEmpty Text	`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:

StartTextTranslationJob, startTextTranslationJob_jobName - The name of the batch translation job to be performed.

StartTextTranslationJob, startTextTranslationJob_parallelDataNames - The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

When you add parallel data to a translation job, you create an /Active Custom Translation/ job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see Customizing your translations with parallel data.

StartTextTranslationJob, startTextTranslationJob_settings - Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

StartTextTranslationJob, startTextTranslationJob_terminologyNames - The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see Custom terminology.

StartTextTranslationJob, startTextTranslationJob_inputDataConfig - Specifies the format and location of the input documents for the translation job.

StartTextTranslationJob, startTextTranslationJob_outputDataConfig - Specifies the S3 folder to which your job output will be saved.

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 information, see Identity and access management .

StartTextTranslationJob, startTextTranslationJob_sourceLanguageCode - The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

StartTextTranslationJob, startTextTranslationJob_targetLanguageCodes - The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

$sel:clientToken:StartTextTranslationJob', startTextTranslationJob_clientToken - A unique identifier for the request. This token is generated for you 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 name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

When you add parallel data to a translation job, you create an /Active Custom Translation/ job.

This parameter accepts only one parallel data resource.

Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see Customizing your translations with parallel data.

startTextTranslationJob_settings :: Lens' StartTextTranslationJob (Maybe TranslationSettings) Source #

Settings to configure your translation output, including the option to set the formality level of the output text and the option to mask profane words and phrases.

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

The name of a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see Custom terminology.

startTextTranslationJob_inputDataConfig :: Lens' StartTextTranslationJob InputDataConfig Source #

Specifies the format and 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 information, see Identity and access management .

startTextTranslationJob_sourceLanguageCode :: Lens' StartTextTranslationJob Text Source #

The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

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

The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

startTextTranslationJob_clientToken :: Lens' StartTextTranslationJob Text Source #

A unique identifier for the request. This token is generated for you 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

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 #
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 #
NFData StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods rnf :: StartTextTranslationJobResponse -> () #
Eq StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob Methods (==) :: StartTextTranslationJobResponse -> StartTextTranslationJobResponse -> Bool # (/=) :: StartTextTranslationJobResponse -> StartTextTranslationJobResponse -> Bool #
type Rep StartTextTranslationJobResponse Source #
Instance details Defined in Amazonka.Translate.StartTextTranslationJob type Rep StartTextTranslationJobResponse = D1 ('MetaData "StartTextTranslationJobResponse" "Amazonka.Translate.StartTextTranslationJob" "amazonka-translate-2.0-L0mihfp7dIB5vR5cgIREJ6" '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:

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

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.