Amazon Translate
    Amazon Translate
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST

      /

      The Amazon Translate multi-region endpoint
      The Amazon Translate multi-region endpoint
      POST
      /
      Retrieves a custom terminology.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://translate.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw ''
      Response Response Example
      200 - Example 1
      {
  "TerminologyProperties": {
    "Name": "string",
    "Description": "string",
    "Arn": "string",
    "SourceLanguageCode": "string",
    "TargetLanguageCodes": [],
    "EncryptionKey": {
      "Type": "KMS",
      "Id": "string"
    },
    "SizeBytes": 0,
    "TermCount": 0,
    "CreatedAt": "string",
    "LastUpdatedAt": "string"
  },
  "TerminologyDataLocation": {
    "RepositoryType": "string",
    "Location": "string"
  }
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      Name
      string 
      required
      The name of the custom terminology being retrieved.
      >= 1 characters<= 256 characters
      Match pattern:
      ^([A-Za-z0-9-]_?)+$
      TerminologyDataFormat
      enum<string> 
      required
      The data format of the custom terminology being retrieved, either CSV or TMX.
      Allowed values:
      CSVTMX
      Examples

      Responses

      🟢200Success
      application/json
      Body
      TerminologyProperties
      object 
      optional
      The properties of the custom terminology being retrieved.
      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.
      TerminologyDataLocation
      object 
      optional
      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.
      RepositoryType
      string 
      required
      The repository type for the custom terminology data.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      Location
      string 
      required
      The location of the custom terminology data.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      🟠480ResourceNotFoundException
      🟠481InvalidParameterValueException
      🟠482TooManyRequestsException
      🟠483InternalServerException
      Modified at 2022-09-12 09:51:45
      Previous
      /
      Next
      /
      Built with