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
      /
      Provides information about a parallel data resource.
      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
      {
  "ParallelDataProperties": {
    "Name": "string",
    "Arn": "string",
    "Description": "string",
    "Status": "CREATING",
    "SourceLanguageCode": "string",
    "TargetLanguageCodes": [],
    "ParallelDataConfig": {
      "S3Uri": "string",
      "Format": "TSV"
    },
    "Message": "string",
    "ImportedDataSize": 0,
    "ImportedRecordCount": 0,
    "FailedRecordCount": 0,
    "SkippedRecordCount": 0,
    "EncryptionKey": {
      "Type": "KMS",
      "Id": "string"
    },
    "CreatedAt": "string",
    "LastUpdatedAt": "string",
    "LatestUpdateAttemptStatus": "CREATING",
    "LatestUpdateAttemptAt": "string"
  },
  "DataLocation": {
    "RepositoryType": "string",
    "Location": "string"
  },
  "AuxiliaryDataLocation": {},
  "LatestUpdateAttemptAuxiliaryDataLocation": {}
}

      Request

      Header Params
      X-Amz-Target
      string 
      required
      Body Params application/json
      Name
      string 
      required
      The name of the parallel data resource that is being retrieved.
      >= 1 characters<= 256 characters
      Match pattern:
      ^([A-Za-z0-9-]_?)+$
      Examples

      Responses

      🟢200Success
      application/json
      Body
      ParallelDataProperties
      object 
      optional
      The properties of the parallel data resource that is being retrieved.
      Name
      string 
      optional
      The custom name assigned to the parallel data resource.
      >= 1 characters<= 256 characters
      Match pattern:
      ^([A-Za-z0-9-]_?)+$
      Arn
      string 
      optional
      The Amazon Resource Name (ARN) of the parallel data resource.
      >= 1 characters<= 512 characters
      Description
      string 
      optional
      The description assigned to the parallel data resource.
      <= 256 characters
      Match pattern:
      [\P{M}\p{M}]{0,256}
      Status
      enum<string> 
      optional
      The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.
      Allowed values:
      CREATINGUPDATINGACTIVEDELETINGFAILED
      SourceLanguageCode
      string 
      optional
      The source language of the translations in the parallel data file.
      >= 2 characters<= 5 characters
      TargetLanguageCodes
      array[string]
      optional
      The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
      ParallelDataConfig
      object 
      optional
      Specifies the format and S3 location of the parallel data input file.
      Message
      string 
      optional
      Additional information from Amazon Translate about the parallel data resource.
      ImportedDataSize
      integer 
      optional
      The number of UTF-8 characters that Amazon Translate imported from the parallel data input file. This number includes only the characters in your translation examples. It does not include characters that are used to format your file. For example, if you provided a Translation Memory Exchange (.tmx) file, this number does not include the tags.
      ImportedRecordCount
      integer 
      optional
      The number of records successfully imported from the parallel data input file.
      FailedRecordCount
      integer 
      optional
      The number of records unsuccessfully imported from the parallel data input file.
      SkippedRecordCount
      integer 
      optional
      The number of items in the input file that Amazon Translate skipped when you created or updated the parallel data resource. For example, Amazon Translate skips empty records, empty target texts, and empty lines.
      EncryptionKey
      object 
      EncryptionKey
      optional
      The encryption key used to encrypt this object.
      CreatedAt
      string <date-time>
      optional
      The time at which the parallel data resource was created.
      LastUpdatedAt
      string <date-time>
      optional
      The time at which the parallel data resource was last updated.
      LatestUpdateAttemptStatus
      enum<string> 
      optional
      The status of the most recent update attempt for the parallel data resource.
      Allowed values:
      CREATINGUPDATINGACTIVEDELETINGFAILED
      LatestUpdateAttemptAt
      string <date-time>
      optional
      The time that the most recent update was attempted.
      DataLocation
      object 
      optional
      The location of the most recent parallel data input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30 minute expiration.
      RepositoryType
      string 
      required
      Describes the repository that contains the parallel data input file.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      Location
      string 
      required
      The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30 minute expiration.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      AuxiliaryDataLocation
      object 
      optional
      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 parallel data resource. The location is returned as a presigned URL to that has a 30 minute expiration.
      RepositoryType
      string 
      required
      Describes the repository that contains the parallel data input file.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      Location
      string 
      required
      The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30 minute expiration.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      LatestUpdateAttemptAuxiliaryDataLocation
      object 
      optional
      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 update a parallel data resource. The location is returned as a presigned URL to that has a 30 minute expiration.
      RepositoryType
      string 
      required
      Describes the repository that contains the parallel data input file.
      <= 10000 characters
      Match pattern:
      [\P{M}\p{M}]{0,10000}
      Location
      string 
      required
      The Amazon S3 location of the parallel data input file. The location is returned as a presigned URL to that has a 30 minute expiration.
      <= 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