/ - Amazon Translate

Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

curl --location -g --request POST 'http://translate.{region}.amazonaws.com/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "Name": "string", "MergeStrategy": "OVERWRITE", "Description": "string", "TerminologyData": { "File": "string", "Format": "CSV" }, "EncryptionKey": { "Type": "KMS", "Id": "string" } }'

{ "TerminologyProperties": { "Name": "string", "Description": "string", "Arn": "string", "SourceLanguageCode": "string", "TargetLanguageCodes": [], "EncryptionKey": { "Type": "KMS", "Id": "string" }, "SizeBytes": 0, "TermCount": 0, "CreatedAt": "string", "LastUpdatedAt": "string" } }

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Name

string

required

The name of the custom terminology being imported.

>= 1 characters<= 256 characters

Match pattern:

^([A-Za-z0-9-]_?)+$

MergeStrategy

enum<string>

required

The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

Allowed value:

OVERWRITE

Description

string

optional

The description of the custom terminology being imported.

<= 256 characters

Match pattern:

[\P{M}\p{M}]{0,256}

TerminologyData

object

required

The terminology data for the custom terminology being imported.

File

string <password>

required

The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

<= 10485760 characters

Format

enum<string>

required

The data format of the custom terminology. Either CSV or TMX.

Allowed values:

CSVTMX

EncryptionKey

object

optional

The encryption key for the custom terminology being imported.

Type

enum<string>

required

The type of encryption key used by Amazon Translate to encrypt custom terminologies.

Allowed value:

KMS

string

required

The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.

>= 1 characters<= 400 characters

Match pattern:

(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\d:)?(\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))

Examples

Responses

🟢200Success

application/json

Body

TerminologyProperties

object

optional

The properties of the custom terminology being imported.

Name

string

optional

The name of the custom terminology.

>= 1 characters<= 256 characters

Match pattern:

^([A-Za-z0-9-]_?)+$

Description

string

optional

The description of the custom terminology properties.

<= 256 characters

Match pattern:

[\P{M}\p{M}]{0,256}

Arn

string

optional

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

>= 1 characters<= 512 characters

SourceLanguageCode

string

optional

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

>= 2 characters<= 5 characters

TargetLanguageCodes

array[string]

optional

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

EncryptionKey

object

optional

The encryption key for the custom terminology.

SizeBytes

integer

optional

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

TermCount

integer

optional

The number of terms included in the custom terminology.

CreatedAt

string <date-time>

optional

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

LastUpdatedAt

string <date-time>

optional

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

🟠480InvalidParameterValueException

🟠481LimitExceededException

🟠482TooManyRequestsException

🟠483InternalServerException