Translate / Client / list_parallel_data

list_parallel_data#

Translate.Client.list_parallel_data(**kwargs)#

Provides a list of your parallel data resources in Amazon Translate.

See also: AWS API Documentation

Request Syntax

response = client.list_parallel_data(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A string that specifies the next page of results to return in a paginated response.

  • MaxResults (integer) – The maximum number of parallel data resources returned for each request.

Return type:

dict

Returns:

Response Syntax

{
    'ParallelDataPropertiesList': [
        {
            '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ParallelDataPropertiesList (list) –

      The properties of the parallel data resources returned by this request.

      • (dict) –

        The properties of a parallel data resource.

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

    • NextToken (string) –

      The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Exceptions