Interface TranslateDocumentCommandOutput

The output of TranslateDocumentCommand.

interface TranslateDocumentCommandOutput {
    $metadata: ResponseMetadata;
    AppliedSettings?: TranslationSettings;
    AppliedTerminologies?: AppliedTerminology[];
    SourceLanguageCode: undefined | string;
    TargetLanguageCode: undefined | string;
    TranslatedDocument: undefined | TranslatedDocument;
}

Hierarchy (view full)

Properties

$metadata AppliedSettings? AppliedTerminologies? SourceLanguageCode TargetLanguageCode TranslatedDocument

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional AppliedSettings

AppliedSettings?: TranslationSettings

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

  • Brevity: reduces the length of the translation output for most translations. Available for TranslateText only.

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

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

Optional AppliedTerminologies

AppliedTerminologies?: AppliedTerminology[]

The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.

SourceLanguageCode

SourceLanguageCode: undefined | string

The language code of the source document.

TargetLanguageCode

TargetLanguageCode: undefined | string

The language code of the translated document.

TranslatedDocument

TranslatedDocument: undefined | TranslatedDocument

The document containing the translated content. The document format matches the source document format.

Settings

Member Visibility

Theme

On This Page