AWS API Changes

2022/02/22 - Amazon Translate - 4 updated api methods

Changes This release enables customers to use translation settings for formality customization in their synchronous translation output.

DescribeTextTranslationJob (updated)

Link ¶
Changes (response)

{'TextTranslationJobProperties': {'Settings': {'Formality': 'FORMAL | '
                                                            'INFORMAL'}}}

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.

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

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 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).
      - 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 configure the translation output.
    - Formality (string) --
    - Profanity (string) --
      
      Enable the profanity setting if you want Amazon Translate 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 does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

ListTextTranslationJobs (updated)

Link ¶
Changes (response)

{'TextTranslationJobPropertiesList': {'Settings': {'Formality': 'FORMAL | '
                                                                'INFORMAL'}}}

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',
                'EncryptionKey': {
                    'Type': 'KMS',
                    'Id': 'string'
                }
            },
            'DataAccessRoleArn': 'string',
            'Settings': {
                'Formality': 'FORMAL'|'INFORMAL',
                'Profanity': 'MASK'
            }
        },
    ],
    '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 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 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).
        
        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 configure the translation output.
      - Formality (string) --
      - Profanity (string) --
        
        Enable the profanity setting if you want Amazon Translate 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 does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

StartTextTranslationJob (updated)

Link ¶
Changes (request)

{'Settings': {'Formality': 'FORMAL | INFORMAL'}}

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.

See also: AWS API Documentation

Request Syntax

client.start_text_translation_job(
    JobName='string',
    InputDataConfig={
        'S3Uri': 'string',
        'ContentType': 'string'
    },
    OutputDataConfig={
        'S3Uri': 'string',
        'EncryptionKey': {
            'Type': 'KMS',
            'Id': 'string'
        }
    },
    DataAccessRoleArn='string',
    SourceLanguageCode='string',
    TargetLanguageCodes=[
        'string',
    ],
    TerminologyNames=[
        'string',
    ],
    ParallelDataNames=[
        'string',
    ],
    ClientToken='string',
    Settings={
        'Formality': 'FORMAL'|'INFORMAL',
        'Profanity': 'MASK'
    }
)

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

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.
EncryptionKey (dict) --

The encryption key used to encrypt this object.
- Type (string) -- [REQUIRED]
  
  The type of encryption key used by Amazon Translate to encrypt this object.
- Id (string) -- [REQUIRED]
  
  The Amazon Resource Name (ARN) of the encryption key being used to encrypt this object.

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 information, 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 a custom terminology resource to add to the translation job. This resource lists examples source terms and the desired translation for each term.

This parameter accepts only one custom terminology resource.

For a list of available custom terminology resources, use the ListTerminologies operation.

For more information, see how-custom-terminology.

(string) --

type ParallelDataNames:

list

param ParallelDataNames:

The name of a parallel data resource to add to the translation job. This resource consists of examples that show how you want segments of text to be translated. When you add parallel data to a translation job, you create an Active Custom Translation job.

This parameter accepts only one parallel data resource.

For a list of available parallel data resources, use the ListParallelData operation.

For more information, see customizing-translations-parallel-data.

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

type Settings:

dict

param Settings:

Settings to configure your translation output, including the option to mask profane words and phrases.

Formality (string) --
Profanity (string) --

Enable the profanity setting if you want Amazon Translate 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 does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

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.

TranslateText (updated)

Link ¶
Changes (request, response)
Request

{'Settings': {'Formality': 'FORMAL | INFORMAL'}}

Response

{'AppliedSettings': {'Formality': 'FORMAL | INFORMAL'}}

Translates input text from the source language to the target language. For a list of available languages and language codes, see what-is-languages.

See also: AWS API Documentation

Request Syntax

client.translate_text(
    Text='string',
    TerminologyNames=[
        'string',
    ],
    SourceLanguageCode='string',
    TargetLanguageCode='string',
    Settings={
        'Formality': 'FORMAL'|'INFORMAL',
        'Profanity': 'MASK'
    }
)

type Text:

string

param Text:

[REQUIRED]

The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

type TerminologyNames:

list

param TerminologyNames:

The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.

(string) --

type SourceLanguageCode:

string

param SourceLanguageCode:

[REQUIRED]

The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-languages.

To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

type TargetLanguageCode:

string

param TargetLanguageCode:

[REQUIRED]

The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

type Settings:

dict

param Settings:

Settings to configure your translation output, including the option to mask profane words and phrases.

Formality (string) --
Profanity (string) --

Enable the profanity setting if you want Amazon Translate 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 does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.

rtype:

dict

returns:

Response Syntax

{
    'TranslatedText': 'string',
    'SourceLanguageCode': 'string',
    'TargetLanguageCode': 'string',
    'AppliedTerminologies': [
        {
            'Name': 'string',
            'Terms': [
                {
                    'SourceText': 'string',
                    'TargetText': 'string'
                },
            ]
        },
    ],
    'AppliedSettings': {
        'Formality': 'FORMAL'|'INFORMAL',
        'Profanity': 'MASK'
    }
}

Response Structure

(dict) --
- TranslatedText (string) --
  
  The translated text.
- SourceLanguageCode (string) --
  
  The language code for the language of the source text.
- TargetLanguageCode (string) --
  
  The language code for the language of the target text.
- AppliedTerminologies (list) --
  
  The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.
  - (dict) --
    
    The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.
    - Name (string) --
      
      The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.
    - Terms (list) --
      
      The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.
      - (dict) --
        
        The term being translated by the custom terminology.
        
        SourceText (string) --
        
        The source text of the term being translated by the custom terminology.
        
        TargetText (string) --
        
        The target text of the term being translated by the custom terminology.
- AppliedSettings (dict) --
  
  Settings that configure the translation output.
  - Formality (string) --
  - Profanity (string) --
    
    Enable the profanity setting if you want Amazon Translate 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 does not detect profanity in all of its supported languages. For languages that support profanity detection, see Supported Languages and Language Codes in the Amazon Translate Developer Guide.