docs.aws.amazon.com/translate/latest/dg/creating-custom-terminology.html\"> Creating a Custom Terminology." }, "TerminologyDataFormat":{ "type":"string", "enum":[ "CSV", "TMX", "TSV" ] }, "TerminologyDataLocation":{ "type":"structure", "required":[ "RepositoryType", "Location" ], "members":{ "RepositoryType":{ "shape":"String", "documentation":"

The repository type for the custom terminology data.

" }, "Location":{ "shape":"String", "documentation":"

The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

Amazon Translate doesn't scan all input files for the risk of CSV injection attacks.

CSV injection occurs when a .csv or .tsv file is altered so that a record contains malicious code. The record begins with a special character, such as =, +, -, or @. When the file is opened in a spreadsheet program, the program might interpret the record as a formula and run the code within it.

Before you download an input file from Amazon S3, ensure that you recognize the file and trust its creator.

" } }, "documentation":"

The location of the custom terminology data.

" }, "TerminologyFile":{ "type":"blob", "max":10485760, "sensitive":true }, "TerminologyProperties":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceName", "documentation":"

The name of the custom terminology.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the custom terminology properties.

" }, "Arn":{ "shape":"TerminologyArn", "documentation":"

The Amazon Resource Name (ARN) of the custom terminology.

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the source text of the translation request for which the custom terminology is being used.

" }, "TargetLanguageCodes":{ "shape":"LanguageCodeStringList", "documentation":"

The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

" }, "EncryptionKey":{ "shape":"EncryptionKey", "documentation":"

The encryption key for the custom terminology.

" }, "SizeBytes":{ "shape":"Integer", "documentation":"

The size of the file used when importing a custom terminology.

" }, "TermCount":{ "shape":"Integer", "documentation":"

The number of terms included in the custom terminology.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The time at which the custom terminology was created, based on the timestamp.

" }, "LastUpdatedAt":{ "shape":"Timestamp", "documentation":"

The time at which the custom terminology was last update, based on the timestamp.

" }, "Directionality":{ "shape":"Directionality", "documentation":"

The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

UNI

  The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

MULTI

  Any language in the terminology resource can be the source language.

" }, "Message":{ "shape":"UnboundedLengthString", "documentation":"

Additional information from Amazon Translate about the terminology resource.

" }, "SkippedTermCount":{ "shape":"Integer", "documentation":"

The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

" }, "Format":{ "shape":"TerminologyDataFormat", "documentation":"

The format of the custom terminology input file.

" } }, "documentation":"

The properties of the custom terminology.

" }, "TerminologyPropertiesList":{ "type":"list", "member":{"shape":"TerminologyProperties"} }, "TextSizeLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

", "exception":true }, "TextTranslationJobFilter":{ "type":"structure", "members":{ "JobName":{ "shape":"JobName", "documentation":"

Filters the list of jobs by name.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

Filters the list of jobs based by job status.

" }, "SubmittedBeforeTime":{ "shape":"Timestamp", "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" }, "SubmittedAfterTime":{ "shape":"Timestamp", "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" } }, "documentation":"

Provides information for filtering a list of translation jobs. For more information, see ListTextTranslationJobs.

" }, "TextTranslationJobProperties":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The ID of the translation job.

" }, "JobName":{ "shape":"JobName", "documentation":"

The user-defined name of the translation job.

" }, "JobStatus":{ "shape":"JobStatus", "documentation":"

The status of the translation job.

" }, "JobDetails":{ "shape":"JobDetails", "documentation":"

The number of documents successfully and unsuccessfully processed during the translation job.

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code of the language of the source text. The language must be a language supported by Amazon Translate.

" }, "TargetLanguageCodes":{ "shape":"TargetLanguageCodeStringList", "documentation":"

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

" }, "TerminologyNames":{ "shape":"ResourceNameList", "documentation":"

A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.

" }, "ParallelDataNames":{ "shape":"ResourceNameList", "documentation":"

A list containing the names of the parallel data resources applied to the translation job.

" }, "Message":{ "shape":"UnboundedLengthString", "documentation":"

An explanation of any errors that may have occurred during the translation job.

" }, "SubmittedTime":{ "shape":"Timestamp", "documentation":"

The time at which the translation job was submitted.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The time at which the translation job ended.

" }, "InputDataConfig":{ "shape":"InputDataConfig", "documentation":"

The input configuration properties that were specified when the job was requested.

" }, "OutputDataConfig":{ "shape":"OutputDataConfig", "documentation":"

The output configuration properties that were specified when the job was requested.

" }, "DataAccessRoleArn":{ "shape":"IamRoleArn", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

" }, "Settings":{ "shape":"TranslationSettings", "documentation":"

Settings that modify the translation output.

" } }, "documentation":"

Provides information about a translation job.

" }, "TextTranslationJobPropertiesList":{ "type":"list", "member":{"shape":"TextTranslationJobProperties"} }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have made too many requests within a short period of time. Wait for a short time and then try your request again.

", "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"String"}, "ResourceArn":{"shape":"ResourceArn"} }, "documentation":"

You have added too many tags to this resource. The maximum is 50 tags.

", "exception":true }, "TranslateDocumentRequest":{ "type":"structure", "required":[ "Document", "SourceLanguageCode", "TargetLanguageCode" ], "members":{ "Document":{ "shape":"Document", "documentation":"

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

" }, "TerminologyNames":{ "shape":"ResourceNameList", "documentation":"

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.

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

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.

" }, "TargetLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

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

" }, "Settings":{ "shape":"TranslationSettings", "documentation":"

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.

" } } }, "TranslateDocumentResponse":{ "type":"structure", "required":[ "TranslatedDocument", "SourceLanguageCode", "TargetLanguageCode" ], "members":{ "TranslatedDocument":{ "shape":"TranslatedDocument", "documentation":"

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

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code of the source document.

" }, "TargetLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code of the translated document.

" }, "AppliedTerminologies":{ "shape":"AppliedTerminologyList", "documentation":"

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

" }, "AppliedSettings":{"shape":"TranslationSettings"} } }, "TranslateTextRequest":{ "type":"structure", "required":[ "Text", "SourceLanguageCode", "TargetLanguageCode" ], "members":{ "Text":{ "shape":"BoundedLengthString", "documentation":"

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

" }, "TerminologyNames":{ "shape":"ResourceNameList", "documentation":"

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.

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the language of the source text. For a list of 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 `TranslateText` request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.

" }, "TargetLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

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

" }, "Settings":{ "shape":"TranslationSettings", "documentation":"

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

- Brevity: reduces the length of the translated output for most translations.

- Formality: sets the formality level of the output text.

- Profanity: masks profane words and phrases in your translation output.

" } } }, "TranslateTextResponse":{ "type":"structure", "required":[ "TranslatedText", "SourceLanguageCode", "TargetLanguageCode" ], "members":{ "TranslatedText":{ "shape":"TranslatedTextString", "documentation":"

The translated text.

" }, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the language of the source text.

" }, "TargetLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the language of the target text.

" }, "AppliedTerminologies":{ "shape":"AppliedTerminologyList", "documentation":"

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

" }, "AppliedSettings":{ "shape":"TranslationSettings", "documentation":"

Optional settings that modify the translation output.

" } } }, "TranslatedDocument":{ "type":"structure", "required":["Content"], "members":{ "Content":{ "shape":"TranslatedDocumentContent", "documentation":"

The document containing the translated content.

" } }, "documentation":"

The translated content.

" }, "TranslatedDocumentContent":{ "type":"blob", "sensitive":true }, "TranslatedTextString":{ "type":"string", "max":20000, "pattern":"[\\P{M}\\p{M}]{0,20000}" }, "TranslationSettings":{ "type":"structure", "members":{ "Formality":{ "shape":"Formality", "documentation":"

You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don't specify a value for formality, or if the target language doesn't support formality, the translation will ignore the formality setting.

If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.

For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.

" }, "Profanity":{ "shape":"Profanity", "documentation":"

You can enable the profanity setting if you want 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 doesn't detect profanity in all of its supported languages. For languages that don't support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.

If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don't support profanity masking, the translation job won't mask profanity for any target language.

" }, "Brevity":{ "shape":"Brevity", "documentation":"

When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.

If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.

For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.

" } }, "documentation":"

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.

" }, "UnboundedLengthString":{"type":"string"}, "UnsupportedDisplayLanguageCodeException":{ "type":"structure", "members":{ "Message":{"shape":"String"}, "DisplayLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

Language code passed in with the request.

" } }, "documentation":"

Requested display language code is not supported.

", "exception":true }, "UnsupportedLanguagePairException":{ "type":"structure", "members":{ "Message":{"shape":"String"}, "SourceLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the language of the input text.

" }, "TargetLanguageCode":{ "shape":"LanguageCodeString", "documentation":"

The language code for the language of the translated text.

" } }, "documentation":"

Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateParallelDataRequest":{ "type":"structure", "required":[ "Name", "ParallelDataConfig", "ClientToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

The name of the parallel data resource being updated.

" }, "Description":{ "shape":"Description", "documentation":"

A custom description for the parallel data resource in Amazon Translate.

" }, "ParallelDataConfig":{ "shape":"ParallelDataConfig", "documentation":"

Specifies the format and S3 location of the parallel data input file.

" }, "ClientToken":{ "shape":"ClientTokenString", "documentation":"

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

", "idempotencyToken":true } } }, "UpdateParallelDataResponse":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceName", "documentation":"

The name of the parallel data resource being updated.

" }, "Status":{ "shape":"ParallelDataStatus", "documentation":"

The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either `ACTIVE` or `FAILED`.

" }, "LatestUpdateAttemptStatus":{ "shape":"ParallelDataStatus", "documentation":"

The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is `ACTIVE`.

" }, "LatestUpdateAttemptAt":{ "shape":"Timestamp", "documentation":"

The time that the most recent update was attempted.

" } } } }, "documentation":"

Provides translation of the input content from the source language to the target language.

" }