AWS API Changes

2020/11/23 - Amazon Translate - 5 new 3 updated api methods

Changes This update adds new operations to create and manage parallel data in Amazon Translate. Parallel data is a resource that you can use to run Active Custom Translation jobs.

GetParallelData (new)

Link ¶

Provides information about a parallel data resource.

See also: AWS API Documentation

Request Syntax

client.get_parallel_data(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

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

rtype

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 custom terminologies.
    - Id (string) --
      
      The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
  - 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 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) --
    
    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.
- 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.
- 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.

DeleteParallelData (new)

Link ¶

Deletes a parallel data resource in Amazon Translate.

See also: AWS API Documentation

Request Syntax

client.delete_parallel_data(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED'
}

Response Structure

(dict) --
- Name (string) --
  
  The name of the parallel data resource that is being deleted.
- Status (string) --
  
  The status of the parallel data deletion.

CreateParallelData (new)

Link ¶

Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples of source phrases and their translations from your translation memory. By adding parallel data, you can influence the style, tone, and word choice in your translation output.

See also: AWS API Documentation

Request Syntax

client.create_parallel_data(
    Name='string',
    Description='string',
    ParallelDataConfig={
        'S3Uri': 'string',
        'Format': 'TSV'|'CSV'|'TMX'
    },
    EncryptionKey={
        'Type': 'KMS',
        'Id': 'string'
    },
    ClientToken='string'
)

type Name

string

param Name

[REQUIRED]

A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.

type Description

string

param Description

A custom description for the parallel data resource in Amazon Translate.

type ParallelDataConfig

dict

param ParallelDataConfig

[REQUIRED]

Specifies the format and S3 location of the parallel data input file.

S3Uri (string) -- [REQUIRED]

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) -- [REQUIRED]

The format of the parallel data input file.

type EncryptionKey

dict

param EncryptionKey

The encryption key used to encrypt this object.

Type (string) -- [REQUIRED]

The type of encryption key used by Amazon Translate to encrypt custom terminologies.
Id (string) -- [REQUIRED]

The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.

type ClientToken

string

param ClientToken

[REQUIRED]

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED'
}

Response Structure

(dict) --
- Name (string) --
  
  The custom name that you assigned to the parallel data resource.
- Status (string) --
  
  The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE .

ListParallelData (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

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

type NextToken

string

param NextToken

A string that specifies the next page of results to return in a paginated response.

type MaxResults

integer

param MaxResults

The maximum number of parallel data resources returned for each request.

rtype

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 custom terminologies.
      - Id (string) --
        
        The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    - 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.

UpdateParallelData (new)

Link ¶

Updates a previously created parallel data resource by importing a new input file from Amazon S3.

See also: AWS API Documentation

Request Syntax

client.update_parallel_data(
    Name='string',
    Description='string',
    ParallelDataConfig={
        'S3Uri': 'string',
        'Format': 'TSV'|'CSV'|'TMX'
    },
    ClientToken='string'
)

type Name

string

param Name

[REQUIRED]

The name of the parallel data resource being updated.

type Description

string

param Description

A custom description for the parallel data resource in Amazon Translate.

type ParallelDataConfig

dict

param ParallelDataConfig

[REQUIRED]

Specifies the format and S3 location of the parallel data input file.

S3Uri (string) -- [REQUIRED]

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) -- [REQUIRED]

The format of the parallel data input file.

type ClientToken

string

param ClientToken

[REQUIRED]

A unique identifier for the request. This token is automatically generated when you use Amazon Translate through an AWS SDK.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'Name': 'string',
    'Status': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
    'LatestUpdateAttemptStatus': 'CREATING'|'UPDATING'|'ACTIVE'|'DELETING'|'FAILED',
    'LatestUpdateAttemptAt': datetime(2015, 1, 1)
}

Response Structure

(dict) --
- Name (string) --
  
  The name of the parallel data resource being updated.
- Status (string) --
  
  The status of the parallel data resource that you are attempting to update. Your update request is accepted only if this status is either ACTIVE or FAILED .
- LatestUpdateAttemptStatus (string) --
  
  The status of the parallel data update attempt. When the updated parallel data resource is ready for you to use, the status is ACTIVE .
- LatestUpdateAttemptAt (datetime) --
  
  The time that the most recent update was attempted.

DescribeTextTranslationJob (updated)

Link ¶
Changes (response)

{'TextTranslationJobProperties': {'ParallelDataNames': ['string']}}

Gets the properties associated with an asycnhronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

See also: AWS API Documentation

Request Syntax

client.describe_text_translation_job(
    JobId='string'
)

type JobId

string

param JobId

[REQUIRED]

The identifier that Amazon Translate generated for the job. The StartTextTranslationJob operation returns this identifier in its response.

rtype

dict

returns

Response Syntax

{
    'TextTranslationJobProperties': {
        'JobId': 'string',
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'JobDetails': {
            'TranslatedDocumentsCount': 123,
            'DocumentsWithErrorsCount': 123,
            'InputDocumentsCount': 123
        },
        'SourceLanguageCode': 'string',
        'TargetLanguageCodes': [
            'string',
        ],
        'TerminologyNames': [
            'string',
        ],
        'ParallelDataNames': [
            'string',
        ],
        'Message': 'string',
        'SubmittedTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'InputDataConfig': {
            'S3Uri': 'string',
            'ContentType': 'string'
        },
        'OutputDataConfig': {
            'S3Uri': 'string'
        },
        'DataAccessRoleArn': 'string'
    }
}

Response Structure

(dict) --
- TextTranslationJobProperties (dict) --
  
  An object that contains the properties associated with an asynchronous batch translation job.
  - JobId (string) --
    
    The ID of the translation job.
  - JobName (string) --
    
    The user-defined name of the translation job.
  - JobStatus (string) --
    
    The status of the translation job.
  - JobDetails (dict) --
    
    The number of documents successfully and unsuccessfully processed during the translation job.
    - TranslatedDocumentsCount (integer) --
      
      The number of documents successfully processed during a translation job.
    - DocumentsWithErrorsCount (integer) --
      
      The number of documents that could not be processed during a translation job.
    - InputDocumentsCount (integer) --
      
      The number of documents used as input in a translation job.
  - SourceLanguageCode (string) --
    
    The language code of the language of the source text. The language must be a language supported by Amazon Translate.
  - TargetLanguageCodes (list) --
    
    The language code of the language of the target text. The language must be a language supported by Amazon Translate.
    - (string) --
  - TerminologyNames (list) --
    
    A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
    - (string) --
  - ParallelDataNames (list) --
    
    A list containing the names of the parallel data resources applied to the translation job.
    - (string) --
  - Message (string) --
    
    An explanation of any errors that may have occured during the translation job.
  - SubmittedTime (datetime) --
    
    The time at which the translation job was submitted.
  - EndTime (datetime) --
    
    The time at which the translation job ended.
  - InputDataConfig (dict) --
    
    The input configuration properties that were specified when the job was requested.
    - S3Uri (string) --
      
      The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.
    - ContentType (string) --
      
      Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
      - text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
      - text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
      - application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
      - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
      Warning
      
      If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.
  - OutputDataConfig (dict) --
    
    The output configuration properties that were specified when the job was requested.
    - S3Uri (string) --
      
      The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
  - DataAccessRoleArn (string) --
    
    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.

ListTextTranslationJobs (updated)

Link ¶
Changes (response)

{'TextTranslationJobPropertiesList': {'ParallelDataNames': ['string']}}

Gets a list of the batch translation jobs that you have submitted.

See also: AWS API Documentation

Request Syntax

client.list_text_translation_jobs(
    Filter={
        'JobName': 'string',
        'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
        'SubmittedBeforeTime': datetime(2015, 1, 1),
        'SubmittedAfterTime': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

type Filter

dict

param Filter

The parameters that specify which batch translation jobs to retrieve. Filters include job name, job status, and submission time. You can only set one filter at a time.

JobName (string) --

Filters the list of jobs by name.
JobStatus (string) --

Filters the list of jobs based by job status.
SubmittedBeforeTime (datetime) --

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.
SubmittedAfterTime (datetime) --

Filters the list of jobs based on the time that the job was submitted for processing and returns only the jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

type NextToken

string

param NextToken

The token to request the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in each page. The default value is 100.

rtype

dict

returns

Response Syntax

{
    'TextTranslationJobPropertiesList': [
        {
            'JobId': 'string',
            'JobName': 'string',
            'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED',
            'JobDetails': {
                'TranslatedDocumentsCount': 123,
                'DocumentsWithErrorsCount': 123,
                'InputDocumentsCount': 123
            },
            'SourceLanguageCode': 'string',
            'TargetLanguageCodes': [
                'string',
            ],
            'TerminologyNames': [
                'string',
            ],
            'ParallelDataNames': [
                'string',
            ],
            'Message': 'string',
            'SubmittedTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'InputDataConfig': {
                'S3Uri': 'string',
                'ContentType': 'string'
            },
            'OutputDataConfig': {
                'S3Uri': 'string'
            },
            'DataAccessRoleArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- TextTranslationJobPropertiesList (list) --
  
  A list containing the properties of each job that is returned.
  - (dict) --
    
    Provides information about a translation job.
    - JobId (string) --
      
      The ID of the translation job.
    - JobName (string) --
      
      The user-defined name of the translation job.
    - JobStatus (string) --
      
      The status of the translation job.
    - JobDetails (dict) --
      
      The number of documents successfully and unsuccessfully processed during the translation job.
      - TranslatedDocumentsCount (integer) --
        
        The number of documents successfully processed during a translation job.
      - DocumentsWithErrorsCount (integer) --
        
        The number of documents that could not be processed during a translation job.
      - InputDocumentsCount (integer) --
        
        The number of documents used as input in a translation job.
    - SourceLanguageCode (string) --
      
      The language code of the language of the source text. The language must be a language supported by Amazon Translate.
    - TargetLanguageCodes (list) --
      
      The language code of the language of the target text. The language must be a language supported by Amazon Translate.
      - (string) --
    - TerminologyNames (list) --
      
      A list containing the names of the terminologies applied to a translation job. Only one terminology can be applied per StartTextTranslationJob request at this time.
      - (string) --
    - ParallelDataNames (list) --
      
      A list containing the names of the parallel data resources applied to the translation job.
      - (string) --
    - Message (string) --
      
      An explanation of any errors that may have occured during the translation job.
    - SubmittedTime (datetime) --
      
      The time at which the translation job was submitted.
    - EndTime (datetime) --
      
      The time at which the translation job ended.
    - InputDataConfig (dict) --
      
      The input configuration properties that were specified when the job was requested.
      - S3Uri (string) --
        
        The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.
      - ContentType (string) --
        
        Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
        
        text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
        
        text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
        
        application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
        
        application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
        
        application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
        
        Warning
        
        If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.
    - OutputDataConfig (dict) --
      
      The output configuration properties that were specified when the job was requested.
      - S3Uri (string) --
        
        The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.
    - DataAccessRoleArn (string) --
      
      The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
- NextToken (string) --
  
  The token to use to retreive the next page of results. This value is null when there are no more results to return.

StartTextTranslationJob (updated)

Link ¶
Changes (request)

{'ParallelDataNames': ['string']}

Starts an asynchronous batch translation job. Batch translation jobs can be used to translate large volumes of text across multiple documents at once. For more information, see async.

Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation.

Note

Amazon Translate does not support batch translation of multiple source languages at once.

See also: AWS API Documentation

Request Syntax

client.start_text_translation_job(
    JobName='string',
    InputDataConfig={
        'S3Uri': 'string',
        'ContentType': 'string'
    },
    OutputDataConfig={
        'S3Uri': 'string'
    },
    DataAccessRoleArn='string',
    SourceLanguageCode='string',
    TargetLanguageCodes=[
        'string',
    ],
    TerminologyNames=[
        'string',
    ],
    ParallelDataNames=[
        'string',
    ],
    ClientToken='string'
)

type JobName

string

param JobName

The name of the batch translation job to be performed.

type InputDataConfig

dict

param InputDataConfig

[REQUIRED]

Specifies the format and S3 location of the input documents for the translation job.

S3Uri (string) -- [REQUIRED]

The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.
ContentType (string) -- [REQUIRED]

Describes the format of the data that you submit to Amazon Translate as input. You can specify one of the following multipurpose internet mail extension (MIME) types:
- text/html : The input data consists of one or more HTML files. Amazon Translate translates only the text that resides in the html element in each file.
- text/plain : The input data consists of one or more unformatted text files. Amazon Translate translates every character in this type of input.
- application/vnd.openxmlformats-officedocument.wordprocessingml.document : The input data consists of one or more Word documents (.docx).
- application/vnd.openxmlformats-officedocument.presentationml.presentation : The input data consists of one or more PowerPoint Presentation files (.pptx).
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet : The input data consists of one or more Excel Workbook files (.xlsx).
Warning

If you structure your input data as HTML, ensure that you set this parameter to text/html . By doing so, you cut costs by limiting the translation to the contents of the html element in each file. Otherwise, if you set this parameter to text/plain , your costs will cover the translation of every character.

type OutputDataConfig

dict

param OutputDataConfig

[REQUIRED]

Specifies the S3 folder to which your job output will be saved.

S3Uri (string) -- [REQUIRED]

The URI of the S3 folder that contains a translation job's output file. The folder must be in the same Region as the API endpoint that you are calling.

type DataAccessRoleArn

string

param DataAccessRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

type SourceLanguageCode

string

param SourceLanguageCode

[REQUIRED]

The language code of the input language. For a list of language codes, see what-is-languages.

Amazon Translate does not automatically detect a source language during batch translation jobs.

type TargetLanguageCodes

list

param TargetLanguageCodes

[REQUIRED]

The language code of the output language.

(string) --

type TerminologyNames

list

param TerminologyNames

The name of the terminology to use in the batch translation job. For a list of available terminologies, use the ListTerminologies operation.

(string) --

type ParallelDataNames

list

param ParallelDataNames

The names of the parallel data resources to use in the batch translation job. For a list of available parallel data resources, use the ListParallelData operation.

(string) --

type ClientToken

string

param ClientToken

[REQUIRED]

A unique identifier for the request. This token is auto-generated when using the Amazon Translate SDK.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'JobId': 'string',
    'JobStatus': 'SUBMITTED'|'IN_PROGRESS'|'COMPLETED'|'COMPLETED_WITH_ERROR'|'FAILED'|'STOP_REQUESTED'|'STOPPED'
}

Response Structure

(dict) --
- JobId (string) --
  
  The identifier generated for the job. To get the status of a job, use this ID with the DescribeTextTranslationJob operation.
- JobStatus (string) --
  
  The status of the job. Possible values include:
  - SUBMITTED - The job has been received and is queued for processing.
  - IN_PROGRESS - Amazon Translate is processing the job.
  - COMPLETED - The job was successfully completed and the output is available.
  - COMPLETED_WITH_ERROR - The job was completed with errors. The errors can be analyzed in the job's output.
  - FAILED - The job did not complete. To get details, use the DescribeTextTranslationJob operation.
  - STOP_REQUESTED - The user who started the job has requested that it be stopped.
  - STOPPED - The job has been stopped.