[ aws . translate ]

translate-text

Description

Translates input text from the source language to the target language. For a list of available languages and language codes, see what-is-languages .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  translate-text
--text <value>
[--terminology-names <value>]
--source-language-code <value>
--target-language-code <value>
[--settings <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--text (string)

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

--terminology-names (list)

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

(string)

Syntax:

"string" "string" ...

--source-language-code (string)

The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-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.

--target-language-code (string)

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

--settings (structure)

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

Formality -> (string)

Profanity -> (string)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide .

Shorthand Syntax:

Formality=string,Profanity=string

JSON Syntax:

{
  "Formality": "FORMAL"|"INFORMAL",
  "Profanity": "MASK"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

TranslatedText -> (string)

The translated text.

SourceLanguageCode -> (string)

The language code for the language of the source text.

TargetLanguageCode -> (string)

The language code for the language of the target text.

AppliedTerminologies -> (list)

The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

(structure)

The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.

Name -> (string)

The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

Terms -> (list)

The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.

(structure)

The term being translated by the custom terminology.

SourceText -> (string)

The source text of the term being translated by the custom terminology.

TargetText -> (string)

The target text of the term being translated by the custom terminology.

AppliedSettings -> (structure)

Settings that configure the translation output.

Formality -> (string)

Profanity -> (string)

Enable the profanity setting if you want Amazon Translate to mask profane words and phrases in your translation output.

To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.

Amazon Translate does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide .