Struct aws_sdk_translate::client::fluent_builders::StartTextTranslationJob

pub struct StartTextTranslationJob { /* private fields */ }

Fluent builder constructing a request to StartTextTranslationJob.

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.

Implementations

impl StartTextTranslationJob

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

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 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 input_data_config(self, input: InputDataConfig) -> Self

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

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

Specifies the format and S3 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 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 source_language_code(self, input: impl Into<String>) -> Self

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.

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

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.

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 language code of the output language.

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

The language code of the output language.

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.

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

For more information, see how-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.

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

For more information, see how-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. 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-translations-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. 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-translations-parallel-data.

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

A unique identifier for the request. This token is auto-generated 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 auto-generated when using the Amazon Translate SDK.

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

Settings to configure your translation output, including the option to mask profane words and phrases.

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

Settings to configure your translation output, including the option to mask profane words and phrases.

Trait Implementations

impl Clone for StartTextTranslationJob

fn clone(&self) -> StartTextTranslationJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTextTranslationJob

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

Formats the value using the given formatter.