Translate / Client / describe_text_translation_job

describe_text_translation_job#

Translate.Client.describe_text_translation_job(**kwargs)#

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

Request Syntax

response = client.describe_text_translation_job(
    JobId='string'
)

Parameters:

JobId (string) –

[REQUIRED]

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

Return type:

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',
            'EncryptionKey': {
                'Type': 'KMS',
                'Id': 'string'
            }
        },
        'DataAccessRoleArn': 'string',
        'Settings': {
            'Formality': 'FORMAL'|'INFORMAL',
            'Profanity': 'MASK',
            'Brevity': 'ON'
        }
    }
}

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 occurred 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 files. Amazon Translate translates all the files in the folder and all its sub-folders. 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).
      - application/x-xliff+xml: The input data consists of one or more XML Localization Interchange File Format (XLIFF) files (.xlf). Amazon Translate supports only XLIFF version 1.2.
      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.
    - 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.
  - 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.
  - Settings (dict) –
    
    Settings that modify the translation output.
    - Formality (string) –
      
      You can specify the desired level of formality for translations to supported target languages. The formality setting controls the level of formal language usage (also known as register) in the translation output. You can set the value to informal or formal. If you don’t specify a value for formality, or if the target language doesn’t support formality, the translation will ignore the formality setting.
      
      If you specify multiple target languages for the job, translate ignores the formality setting for any unsupported target language.
      
      For a list of target languages that support formality, see Supported languages in the Amazon Translate Developer Guide.
    - Profanity (string) –
      
      You can enable the profanity setting if you want to mask profane words and phrases in your translation output.
      
      To mask profane words and phrases, Amazon Translate replaces them with the grawlix string “?$#@$“. This 5-character sequence is used for each profane word or phrase, regardless of the length or number of words.
      
      Amazon Translate doesn’t detect profanity in all of its supported languages. For languages that don’t support profanity detection, see Unsupported languages in the Amazon Translate Developer Guide.
      
      If you specify multiple target languages for the job, all the target languages must support profanity masking. If any of the target languages don’t support profanity masking, the translation job won’t mask profanity for any target language.
    - Brevity (string) –
      
      When you turn on brevity, Amazon Translate reduces the length of the translation output for most translations (when compared with the same translation with brevity turned off). By default, brevity is turned off.
      
      If you turn on brevity for a translation request with an unsupported language pair, the translation proceeds with the brevity setting turned off.
      
      For the language pairs that brevity supports, see Using brevity in the Amazon Translate Developer Guide.

Exceptions

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