Amazon Translate
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

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, either CSV or TMX.

Type: String

Valid Values: CSV | TMX

Required: Yes

Response Syntax

{ "TerminologyDataLocation": { "Location": "string", "RepositoryType": "string" }, "TerminologyProperties": { "Arn": "string", "CreatedAt": number, "Description": "string", "EncryptionKey": { "Id": "string", "Type": "string" }, "LastUpdatedAt": number, "Name": "string", "SizeBytes": 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.

TerminologyDataLocation

The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.

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 invalid. 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: