Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetTerminology

Retrieves a custom terminology.

Request Syntax


{
   "Name": "string",
   "TerminologyDataFormat": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

The name of the custom terminology being retrieved.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

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

Required: Yes

TerminologyDataFormat

The data format of the custom terminology being retrieved.

If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

Type: String

Valid Values: CSV | TMX | TSV

Required: No

Response Syntax


{
   "AuxiliaryDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "TerminologyDataLocation": { 
      "Location": "string",
      "RepositoryType": "string"
   },
   "TerminologyProperties": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "Directionality": "string",
      "EncryptionKey": { 
         "Id": "string",
         "Type": "string"
      },
      "Format": "string",
      "LastUpdatedAt": number,
      "Message": "string",
      "Name": "string",
      "SizeBytes": number,
      "SkippedTermCount": number,
      "SourceLanguageCode": "string",
      "TargetLanguageCodes": [ "string" ],
      "TermCount": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuxiliaryDataLocation

The Amazon S3 location of a file that provides any errors or warnings that were produced by your input file. This file was created when Amazon Translate attempted to create a terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.

Type: TerminologyDataLocation object

TerminologyDataLocation

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.

Important

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.

Type: TerminologyDataLocation object

TerminologyProperties

The properties of the custom terminology being retrieved.

Type: TerminologyProperties object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidParameterValueException

The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

HTTP Status Code: 400

ResourceNotFoundException

The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request.

HTTP Status Code: 400

TooManyRequestsException

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

HTTP Status Code: 400