Struct aws_sdk_translate::operation::translate_document::TranslateDocumentInput

#[non_exhaustive]
pub struct TranslateDocumentInput {
    pub document: Option<Document>,
    pub terminology_names: Option<Vec<String>>,
    pub source_language_code: Option<String>,
    pub target_language_code: 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.

document: Option<Document>

The content and content type for the document to be translated. The document size must not exceed 100 KB.

terminology_names: Option<Vec<String>>

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

source_language_code: Option<String>

The language code for the language of the source text. For a list of supported language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

target_language_code: Option<String>

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

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

Implementations

impl TranslateDocumentInput

pub fn document(&self) -> Option<&Document>

The content and content type for the document to be translated. The document size must not exceed 100 KB.

pub fn terminology_names(&self) -> &[String]

The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

Use the ListTerminologies operation to get the available terminology lists.

For more information about custom terminology lists, see Custom terminology.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .terminology_names.is_none().

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

The language code for the language of the source text. For a list of supported language codes, see Supported languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

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

The language code requested for the translated document. For a list of supported language codes, see Supported languages.

pub fn 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.

impl TranslateDocumentInput

pub fn builder() -> TranslateDocumentInputBuilder

Creates a new builder-style object to manufacture TranslateDocumentInput.

Trait Implementations

impl Clone for TranslateDocumentInput

fn clone(&self) -> TranslateDocumentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranslateDocumentInput

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

Formats the value using the given formatter.

impl PartialEq for TranslateDocumentInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TranslateDocumentInput