Translate / Client / get_parallel_data

get_parallel_data#

Translate.Client.get_parallel_data(**kwargs)#

Provides information about a parallel data resource.

Request Syntax

response = client.get_parallel_data(
    Name='string'
)

Parameters:

Name (string) –

[REQUIRED]

The name of the parallel data resource that is being retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'ParallelDataProperties': {
        'Name': 'string',
        'Arn': 'string',
        'Description': 'string',
        'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
        'SourceLanguageCode': 'string',
        'TargetLanguageCodes': [
            'string',
        ],
        'ParallelDataConfig': {
            'S3Uri': 'string',
            'Format': 'TSV'|'CSV'|'TMX'
        },
        'Message': 'string',
        'ImportedDataSize': 123,
        'ImportedRecordCount': 123,
        'FailedRecordCount': 123,
        'SkippedRecordCount': 123,
        'EncryptionKey': {
            'Type': 'KMS',
            'Id': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'LastUpdatedAt': datetime(2015, 1, 1),
        'LatestUpdateAttemptStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
        'LatestUpdateAttemptAt': datetime(2015, 1, 1)
    },
    'DataLocation': {
        'RepositoryType': 'string',
        'Location': 'string'
    },
    'AuxiliaryDataLocation': {
        'RepositoryType': 'string',
        'Location': 'string'
    },
    'LatestUpdateAttemptAuxiliaryDataLocation': {
        'RepositoryType': 'string',
        'Location': 'string'
    }
}

Response Structure

(dict) –
- ParallelDataProperties (dict) –
  
  The properties of the parallel data resource that is being retrieved.
  - Name (string) –
    
    The custom name assigned to the parallel data resource.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the parallel data resource.
  - Description (string) –
    
    The description assigned to the parallel data resource.
  - Status (string) –
    
    The status of the parallel data resource. When the parallel data is ready for you to use, the status is ACTIVE.
  - SourceLanguageCode (string) –
    
    The source language of the translations in the parallel data file.
  - TargetLanguageCodes (list) –
    
    The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.
    - (string) –
  - ParallelDataConfig (dict) –
    
    Specifies the format and S3 location of the parallel data input file.
    - S3Uri (string) –
      
      The URI of the Amazon S3 folder that contains the parallel data input file. The folder must be in the same Region as the API endpoint you are calling.
    - Format (string) –
      
      The format of the parallel data input file.
  - Message (string) –
    
    Additional information from Amazon Translate about the parallel data resource.
  - ImportedDataSize (integer) –
    
    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) –
    
    The number of records successfully imported from the parallel data input file.
  - FailedRecordCount (integer) –
    
    The number of records unsuccessfully imported from the parallel data input file.
  - SkippedRecordCount (integer) –
    
    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 (dict) –
    
    The encryption key used to encrypt this object.
    - Type (string) –
      
      The type of encryption key used by Amazon Translate to encrypt this object.
    - Id (string) –
      
      The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.
  - CreatedAt (datetime) –
    
    The time at which the parallel data resource was created.
  - LastUpdatedAt (datetime) –
    
    The time at which the parallel data resource was last updated.
  - LatestUpdateAttemptStatus (string) –
    
    The status of the most recent update attempt for the parallel data resource.
  - LatestUpdateAttemptAt (datetime) –
    
    The time that the most recent update was attempted.
- DataLocation (dict) –
  
  The Amazon S3 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.
  
  Warning
  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.
  - RepositoryType (string) –
    
    Describes the repository that contains the parallel data input file.
  - Location (string) –
    
    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.
    
    Warning
    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.
- AuxiliaryDataLocation (dict) –
  
  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) –
    
    Describes the repository that contains the parallel data input file.
  - Location (string) –
    
    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.
    
    Warning
    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.
- LatestUpdateAttemptAuxiliaryDataLocation (dict) –
  
  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) –
    
    Describes the repository that contains the parallel data input file.
  - Location (string) –
    
    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.
    
    Warning
    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.

Exceptions

Translate.Client.exceptions.ResourceNotFoundException
Translate.Client.exceptions.InvalidParameterValueException
Translate.Client.exceptions.TooManyRequestsException
Translate.Client.exceptions.InternalServerException