Struct aws_sdk_translate::operation::start_text_translation_job::builders::StartTextTranslationJobFluentBuilder

pub struct StartTextTranslationJobFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartTextTranslationJob.

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.

Implementations

impl StartTextTranslationJobFluentBuilder

pub fn as_input(&self) -> &StartTextTranslationJobInputBuilder

Access the StartTextTranslationJob as a reference.

pub async fn send( self ) -> Result<StartTextTranslationJobOutput, SdkError<StartTextTranslationJobError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartTextTranslationJobOutput, StartTextTranslationJobError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn job_name(self, input: impl Into<String>) -> Self

The name of the batch translation job to be performed.

pub fn set_job_name(self, input: Option<String>) -> Self

The name of the batch translation job to be performed.

pub fn get_job_name(&self) -> &Option<String>

The name of the batch translation job to be performed.

pub fn input_data_config(self, input: InputDataConfig) -> Self

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

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

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

pub fn get_input_data_config(&self) -> &Option<InputDataConfig>

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

pub fn output_data_config(self, input: OutputDataConfig) -> Self

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

pub fn set_output_data_config(self, input: Option<OutputDataConfig>) -> Self

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

pub fn get_output_data_config(&self) -> &Option<OutputDataConfig>

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

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

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 .

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

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 .

pub fn get_data_access_role_arn(&self) -> &Option<String>

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 .

pub fn source_language_code(self, input: impl Into<String>) -> Self

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.

pub fn set_source_language_code(self, input: Option<String>) -> Self

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.

pub fn get_source_language_code(&self) -> &Option<String>

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.

pub fn target_language_codes(self, input: impl Into<String>) -> Self

Appends an item to TargetLanguageCodes.

To override the contents of this collection use set_target_language_codes.

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.

pub fn set_target_language_codes(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_target_language_codes(&self) -> &Option<Vec<String>>

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.

pub fn terminology_names(self, input: impl Into<String>) -> Self

Appends an item to TerminologyNames.

To override the contents of this collection use set_terminology_names.

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.

pub fn set_terminology_names(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_terminology_names(&self) -> &Option<Vec<String>>

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.

pub fn parallel_data_names(self, input: impl Into<String>) -> Self

Appends an item to ParallelDataNames.

To override the contents of this collection use set_parallel_data_names.

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.

pub fn set_parallel_data_names(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_parallel_data_names(&self) -> &Option<Vec<String>>

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.

pub fn client_token(self, input: impl Into<String>) -> Self

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

pub fn set_client_token(self, input: Option<String>) -> Self

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

pub fn get_client_token(&self) -> &Option<String>

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

pub fn settings(self, input: TranslationSettings) -> Self

Settings to configure your translation output. You can configure the following options:

• Brevity: not supported.

• Formality: sets the formality level of the output text.

• Profanity: masks profane words and phrases in your translation output.

pub fn set_settings(self, input: Option<TranslationSettings>) -> Self

Settings to configure your translation output. You can configure the following options:

• Brevity: not supported.

• Formality: sets the formality level of the output text.

• Profanity: masks profane words and phrases in your translation output.

pub fn get_settings(&self) -> &Option<TranslationSettings>

Settings to configure your translation output. You can configure the following options:

• Brevity: not supported.

• Formality: sets the formality level of the output text.

• Profanity: masks profane words and phrases in your translation output.

Trait Implementations

impl Clone for StartTextTranslationJobFluentBuilder

fn clone(&self) -> StartTextTranslationJobFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartTextTranslationJobFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.