Struct aws_sdk_translate::input::StartTextTranslationJobInput

#[non_exhaustive]
pub struct StartTextTranslationJobInput {
    pub job_name: Option<String>,
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub data_access_role_arn: Option<String>,
    pub source_language_code: Option<String>,
    pub target_language_codes: Option<Vec<String>>,
    pub terminology_names: Option<Vec<String>>,
    pub parallel_data_names: Option<Vec<String>>,
    pub client_token: Option<String>,
    pub settings: Option<TranslationSettings>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_name: Option<String>

The name of the batch translation job to be performed.

input_data_config: Option<InputDataConfig>

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

output_data_config: Option<OutputDataConfig>

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

data_access_role_arn: 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.

source_language_code: Option<String>

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.

target_language_codes: Option<Vec<String>>

The language code of the output language.

terminology_names: 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.

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

For more information, see how-custom-terminology.

parallel_data_names: 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. 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.

client_token: Option<String>

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

settings: Option<TranslationSettings>

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

Implementations

impl StartTextTranslationJobInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<StartTextTranslationJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartTextTranslationJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartTextTranslationJobInput

impl StartTextTranslationJobInput

pub fn job_name(&self) -> Option<&str>

The name of the batch translation job to be performed.

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

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

pub fn 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) -> Option<&str>

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) -> Option<&str>

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) -> Option<&[String]>

The language code of the output language.

pub fn terminology_names(&self) -> Option<&[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.

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) -> Option<&[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. 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) -> Option<&str>

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

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

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

Trait Implementations

impl Clone for StartTextTranslationJobInput

fn clone(&self) -> StartTextTranslationJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTextTranslationJobInput

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

Formats the value using the given formatter.

impl PartialEq<StartTextTranslationJobInput> for StartTextTranslationJobInput

fn eq(&self, other: &StartTextTranslationJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StartTextTranslationJobInput) -> bool

This method tests for !=.

impl StructuralPartialEq for StartTextTranslationJobInput