Class: AWS.Translate

var params = {
  Name: 'STRING_VALUE' /* required */
};
translate.deleteParallelData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

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

    • Status — (String)

      The status of the parallel data deletion.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
translate.deleteTerminology(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the custom terminology being deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
translate.describeTextTranslationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TextTranslationJobProperties — (map)

      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.

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "COMPLETED_WITH_ERROR"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • JobDetails — (map)

        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 — (Array<String>)

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

      • TerminologyNames — (Array<String>)

        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.

      • ParallelDataNames — (Array<String>)

        A list containing the names of the parallel data resources applied to the translation job.

      • Message — (String)

        An explanation of any errors that may have occurred during the translation job.

      • SubmittedTime — (Date)

        The time at which the translation job was submitted.

      • EndTime — (Date)

        The time at which the translation job ended.

      • InputDataConfig — (map)

        The input configuration properties that were specified when the job was requested.

        • S3Uri — required — (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 — required — (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.

          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 — (map)

        The output configuration properties that were specified when the job was requested.

        • S3Uri — required — (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 — (map)

          The encryption key used to encrypt this object.

          • Type — required — (String)

            The type of encryption key used by Amazon Translate to encrypt this object.

            Possible values include:
            • "KMS"
          • Id — required — (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 — (map)

        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.

          Possible values include:
          • "FORMAL"
          • "INFORMAL"
        • 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.

          Possible values include:
          • "MASK"
        • 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.

          Possible values include:
          • "ON"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE' /* required */
};
translate.getParallelData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ParallelDataProperties — (map)

      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.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • SourceLanguageCode — (String)

        The source language of the translations in the parallel data file.

      • TargetLanguageCodes — (Array<String>)

        The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

      • ParallelDataConfig — (map)

        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.

          Possible values include:
          • "TSV"
          • "CSV"
          • "TMX"
      • 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 — (map)

        The encryption key used to encrypt this object.

        • Type — required — (String)

          The type of encryption key used by Amazon Translate to encrypt this object.

          Possible values include:
          • "KMS"
        • Id — required — (String)

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

      • CreatedAt — (Date)

        The time at which the parallel data resource was created.

      • LastUpdatedAt — (Date)

        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.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • LatestUpdateAttemptAt — (Date)

        The time that the most recent update was attempted.

    • DataLocation — (map)

      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.

      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 — required — (String)

        Describes the repository that contains the parallel data input file.

      • Location — required — (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.

        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 — (map)

      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 — required — (String)

        Describes the repository that contains the parallel data input file.

      • Location — required — (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.

        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 — (map)

      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 — required — (String)

        Describes the repository that contains the parallel data input file.

      • Location — required — (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.

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Name: 'STRING_VALUE', /* required */
  TerminologyDataFormat: CSV | TMX | TSV
};
translate.getTerminology(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the custom terminology being retrieved.

  • TerminologyDataFormat — (String)

    The data format of the custom terminology being retrieved.

    If you don't specify this parameter, Amazon Translate returns a file with the same format as the file that was imported to create the terminology.

    If you specify this parameter when you retrieve a multi-directional terminology resource, you must specify the same format as the input file that was imported to create it. Otherwise, Amazon Translate throws an error.

    Possible values include:
    • "CSV"
    • "TMX"
    • "TSV"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TerminologyProperties — (map)

      The properties of the custom terminology being retrieved.

      • Name — (String)

        The name of the custom terminology.

      • Description — (String)

        The description of the custom terminology properties.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the custom terminology.

      • SourceLanguageCode — (String)

        The language code for the source text of the translation request for which the custom terminology is being used.

      • TargetLanguageCodes — (Array<String>)

        The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

      • EncryptionKey — (map)

        The encryption key for the custom terminology.

        • Type — required — (String)

          The type of encryption key used by Amazon Translate to encrypt this object.

          Possible values include:
          • "KMS"
        • Id — required — (String)

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

      • SizeBytes — (Integer)

        The size of the file used when importing a custom terminology.

      • TermCount — (Integer)

        The number of terms included in the custom terminology.

      • CreatedAt — (Date)

        The time at which the custom terminology was created, based on the timestamp.

      • LastUpdatedAt — (Date)

        The time at which the custom terminology was last update, based on the timestamp.

      • Directionality — (String)

        The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

        UNI

        The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

        MULTI

        Any language in the terminology resource can be the source language.

        Possible values include:
        • "UNI"
        • "MULTI"
      • Message — (String)

        Additional information from Amazon Translate about the terminology resource.

      • SkippedTermCount — (Integer)

        The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

      • Format — (String)

        The format of the custom terminology input file.

        Possible values include:
        • "CSV"
        • "TMX"
        • "TSV"
    • TerminologyDataLocation — (map)

      The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration.

      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 — required — (String)

        The repository type for the custom terminology data.

      • Location — required — (String)

        The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

        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 — (map)

      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 terminology resource. The location is returned as a presigned URL to that has a 30-minute expiration.

      • RepositoryType — required — (String)

        The repository type for the custom terminology data.

      • Location — required — (String)

        The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MergeStrategy: OVERWRITE, /* required */
  Name: 'STRING_VALUE', /* required */
  TerminologyData: { /* required */
    File: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
    Format: CSV | TMX | TSV, /* required */
    Directionality: UNI | MULTI
  },
  Description: 'STRING_VALUE',
  EncryptionKey: {
    Id: 'STRING_VALUE', /* required */
    Type: KMS /* required */
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
translate.importTerminology(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the custom terminology being imported.

  • MergeStrategy — (String)

    The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

    Possible values include:
    • "OVERWRITE"
  • Description — (String)

    The description of the custom terminology being imported.

  • TerminologyData — (map)

    The terminology data for the custom terminology being imported.

    • File — required — (Buffer, Typed Array, Blob, String)

      The file containing the custom terminology data. Your version of the AWS SDK performs a Base64-encoding on this field before sending a request to the AWS service. Users of the SDK should not perform Base64-encoding themselves.

    • Format — required — (String)

      The data format of the custom terminology.

      Possible values include:
      • "CSV"
      • "TMX"
      • "TSV"
    • Directionality — (String)

      The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

      UNI

      The terminology resource has one source language (for example, the first column in a CSV file), and all of its other languages are target languages.

      MULTI

      Any language in the terminology resource can be the source language or a target language. A single multi-directional terminology resource can be used for jobs that translate different language pairs. For example, if the terminology contains English and Spanish terms, it can be used for jobs that translate English to Spanish and Spanish to English.

      When you create a custom terminology resource without specifying the directionality, it behaves as uni-directional terminology, although this parameter will have a null value.

      Possible values include:
      • "UNI"
      • "MULTI"
  • EncryptionKey — (map)

    The encryption key for the custom terminology being imported.

    • Type — required — (String)

      The type of encryption key used by Amazon Translate to encrypt this object.

      Possible values include:
      • "KMS"
    • Id — required — (String)

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

  • Tags — (Array<map>)

    Tags to be associated with this resource. A tag is a key-value pair that adds metadata to a resource. Each tag key for the resource must be unique. For more information, see Tagging your resources.

    • Key — required — (String)

      The initial part of a key-value pair that forms a tag associated with a given resource.

    • Value — required — (String)

      The second part of a key-value pair that forms a tag associated with a given resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TerminologyProperties — (map)

      The properties of the custom terminology being imported.

      • Name — (String)

        The name of the custom terminology.

      • Description — (String)

        The description of the custom terminology properties.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the custom terminology.

      • SourceLanguageCode — (String)

        The language code for the source text of the translation request for which the custom terminology is being used.

      • TargetLanguageCodes — (Array<String>)

        The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

      • EncryptionKey — (map)

        The encryption key for the custom terminology.

        • Type — required — (String)

          The type of encryption key used by Amazon Translate to encrypt this object.

          Possible values include:
          • "KMS"
        • Id — required — (String)

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

      • SizeBytes — (Integer)

        The size of the file used when importing a custom terminology.

      • TermCount — (Integer)

        The number of terms included in the custom terminology.

      • CreatedAt — (Date)

        The time at which the custom terminology was created, based on the timestamp.

      • LastUpdatedAt — (Date)

        The time at which the custom terminology was last update, based on the timestamp.

      • Directionality — (String)

        The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

        UNI

        The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

        MULTI

        Any language in the terminology resource can be the source language.

        Possible values include:
        • "UNI"
        • "MULTI"
      • Message — (String)

        Additional information from Amazon Translate about the terminology resource.

      • SkippedTermCount — (Integer)

        The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

      • Format — (String)

        The format of the custom terminology input file.

        Possible values include:
        • "CSV"
        • "TMX"
        • "TSV"
    • AuxiliaryDataLocation — (map)

      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 terminology resource. The location is returned as a presigned URL to that has a 30 minute expiration.

      • RepositoryType — required — (String)

        The repository type for the custom terminology data.

      • Location — required — (String)

        The Amazon S3 location of the most recent custom terminology input file that was successfully imported into Amazon Translate. The location is returned as a presigned URL that has a 30-minute expiration .

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  DisplayLanguageCode: de | en | es | fr | it | ja | ko | pt | zh | zh-TW,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
translate.listLanguages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DisplayLanguageCode — (String)

    The language code for the language to use to display the language names in the response. The language code is en by default.

    Possible values include:
    • "de"
    • "en"
    • "es"
    • "fr"
    • "it"
    • "ja"
    • "ko"
    • "pt"
    • "zh"
    • "zh-TW"
  • NextToken — (String)

    Include the NextToken value to fetch the next group of supported languages.

  • MaxResults — (Integer)

    The maximum number of results to return in each response.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Languages — (Array<map>)

      The list of supported languages.

      • LanguageName — required — (String)

        Language name of the supported language.

      • LanguageCode — required — (String)

        Language code for the supported language.

    • DisplayLanguageCode — (String)

      The language code passed in with the request.

      Possible values include:
      • "de"
      • "en"
      • "es"
      • "fr"
      • "it"
      • "ja"
      • "ko"
      • "pt"
      • "zh"
      • "zh-TW"
    • NextToken — (String)

      If the response does not include all remaining results, use the NextToken in the next request to fetch the next group of supported languages.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
translate.listParallelData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • 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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ParallelDataPropertiesList — (Array<map>)

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

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

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • SourceLanguageCode — (String)

        The source language of the translations in the parallel data file.

      • TargetLanguageCodes — (Array<String>)

        The language codes for the target languages available in the parallel data file. All possible target languages are returned as an array.

      • ParallelDataConfig — (map)

        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.

          Possible values include:
          • "TSV"
          • "CSV"
          • "TMX"
      • 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 — (map)

        The encryption key used to encrypt this object.

        • Type — required — (String)

          The type of encryption key used by Amazon Translate to encrypt this object.

          Possible values include:
          • "KMS"
        • Id — required — (String)

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

      • CreatedAt — (Date)

        The time at which the parallel data resource was created.

      • LastUpdatedAt — (Date)

        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.

        Possible values include:
        • "CREATING"
        • "UPDATING"
        • "ACTIVE"
        • "DELETING"
        • "FAILED"
      • LatestUpdateAttemptAt — (Date)

        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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
translate.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the given Amazon Translate resource you are querying.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (Array<map>)

      Tags associated with the Amazon Translate resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Translate. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

      • Key — required — (String)

        The initial part of a key-value pair that forms a tag associated with a given resource.

      • Value — required — (String)

        The second part of a key-value pair that forms a tag associated with a given resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
translate.listTerminologies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

  • MaxResults — (Integer)

    The maximum number of custom terminologies returned per list request.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TerminologyPropertiesList — (Array<map>)

      The properties list of the custom terminologies returned on the list request.

      • Name — (String)

        The name of the custom terminology.

      • Description — (String)

        The description of the custom terminology properties.

      • Arn — (String)

        The Amazon Resource Name (ARN) of the custom terminology.

      • SourceLanguageCode — (String)

        The language code for the source text of the translation request for which the custom terminology is being used.

      • TargetLanguageCodes — (Array<String>)

        The language codes for the target languages available with the custom terminology resource. All possible target languages are returned in array.

      • EncryptionKey — (map)

        The encryption key for the custom terminology.

        • Type — required — (String)

          The type of encryption key used by Amazon Translate to encrypt this object.

          Possible values include:
          • "KMS"
        • Id — required — (String)

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

      • SizeBytes — (Integer)

        The size of the file used when importing a custom terminology.

      • TermCount — (Integer)

        The number of terms included in the custom terminology.

      • CreatedAt — (Date)

        The time at which the custom terminology was created, based on the timestamp.

      • LastUpdatedAt — (Date)

        The time at which the custom terminology was last update, based on the timestamp.

      • Directionality — (String)

        The directionality of your terminology resource indicates whether it has one source language (uni-directional) or multiple (multi-directional).

        UNI

        The terminology resource has one source language (the first column in a CSV file), and all of its other languages are target languages.

        MULTI

        Any language in the terminology resource can be the source language.

        Possible values include:
        • "UNI"
        • "MULTI"
      • Message — (String)

        Additional information from Amazon Translate about the terminology resource.

      • SkippedTermCount — (Integer)

        The number of terms in the input file that Amazon Translate skipped when you created or updated the terminology resource.

      • Format — (String)

        The format of the custom terminology input file.

        Possible values include:
        • "CSV"
        • "TMX"
        • "TSV"
    • NextToken — (String)

      If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Filter: {
    JobName: 'STRING_VALUE',
    JobStatus: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERROR | FAILED | STOP_REQUESTED | STOPPED,
    SubmittedAfterTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SubmittedBeforeTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
translate.listTextTranslationJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    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.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "COMPLETED_WITH_ERROR"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"
    • SubmittedBeforeTime — (Date)

      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 — (Date)

      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.

  • NextToken — (String)

    The token to request the next page of results.

  • MaxResults — (Integer)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TextTranslationJobPropertiesList — (Array<map>)

      A list containing the properties of each job that is returned.

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

        Possible values include:
        • "SUBMITTED"
        • "IN_PROGRESS"
        • "COMPLETED"
        • "COMPLETED_WITH_ERROR"
        • "FAILED"
        • "STOP_REQUESTED"
        • "STOPPED"
      • JobDetails — (map)

        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 — (Array<String>)

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

      • TerminologyNames — (Array<String>)

        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.

      • ParallelDataNames — (Array<String>)

        A list containing the names of the parallel data resources applied to the translation job.

      • Message — (String)

        An explanation of any errors that may have occurred during the translation job.

      • SubmittedTime — (Date)

        The time at which the translation job was submitted.

      • EndTime — (Date)

        The time at which the translation job ended.

      • InputDataConfig — (map)

        The input configuration properties that were specified when the job was requested.

        • S3Uri — required — (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 — required — (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.

          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 — (map)

        The output configuration properties that were specified when the job was requested.

        • S3Uri — required — (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 — (map)

          The encryption key used to encrypt this object.

          • Type — required — (String)

            The type of encryption key used by Amazon Translate to encrypt this object.

            Possible values include:
            • "KMS"
          • Id — required — (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 — (map)

        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.

          Possible values include:
          • "FORMAL"
          • "INFORMAL"
        • 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.

          Possible values include:
          • "MASK"
        • 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.

          Possible values include:
          • "ON"
    • 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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  DataAccessRoleArn: 'STRING_VALUE', /* required */
  InputDataConfig: { /* required */
    ContentType: 'STRING_VALUE', /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  OutputDataConfig: { /* required */
    S3Uri: 'STRING_VALUE', /* required */
    EncryptionKey: {
      Id: 'STRING_VALUE', /* required */
      Type: KMS /* required */
    }
  },
  SourceLanguageCode: 'STRING_VALUE', /* required */
  TargetLanguageCodes: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  JobName: 'STRING_VALUE',
  ParallelDataNames: [
    'STRING_VALUE',
    /* more items */
  ],
  Settings: {
    Brevity: ON,
    Formality: FORMAL | INFORMAL,
    Profanity: MASK
  },
  TerminologyNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
translate.startTextTranslationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobName — (String)

    The name of the batch translation job to be performed.

  • InputDataConfig — (map)

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

    • S3Uri — required — (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 — required — (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.

      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 — (map)

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

    • S3Uri — required — (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 — (map)

      The encryption key used to encrypt this object.

      • Type — required — (String)

        The type of encryption key used by Amazon Translate to encrypt this object.

        Possible values include:
        • "KMS"
      • Id — required — (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 grants Amazon Translate read access to your input data. For more information, see Identity and access management .

  • SourceLanguageCode — (String)

    The language code of the input language. Specify the language if all input documents share the same language. If you don't know the language of the source files, or your input documents contains different source languages, select auto. Amazon Translate auto detects the source language for each input document. For a list of supported language codes, see Supported languages.

  • TargetLanguageCodes — (Array<String>)

    The target languages of the translation job. Enter up to 10 language codes. Each input file is translated into each target language.

    Each language code is 2 or 5 characters long. For a list of language codes, see Supported languages.

  • TerminologyNames — (Array<String>)

    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.

    If you specify multiple target languages for the job, translate uses the designated terminology for each requested target language that has an entry for the source term in the terminology file.

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

    For more information, see Custom terminology.

  • ParallelDataNames — (Array<String>)

    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. If you specify multiple target languages for the job, the parallel data file must include translations for all the target languages.

    When you add parallel data to a translation job, you create an Active Custom Translation job.

    This parameter accepts only one parallel data resource.

    Note: Active Custom Translation jobs are priced at a higher rate than other jobs that don't use parallel data. For more information, see Amazon Translate pricing.

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

    For more information, see Customizing your translations with parallel data.

  • ClientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • Settings — (map)

    Settings to configure your translation output. You can configure the following options:

    • Brevity: not supported.

    • Formality: sets the formality level of the output text.

    • Profanity: masks profane words and phrases in your 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.

      Possible values include:
      • "FORMAL"
      • "INFORMAL"
    • 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.

      Possible values include:
      • "MASK"
    • 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.

      Possible values include:
      • "ON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "COMPLETED_WITH_ERROR"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  JobId: 'STRING_VALUE' /* required */
};
translate.stopTextTranslationJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • JobId — (String)

    The job ID of the job to be stopped.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • JobId — (String)

      The job ID of the stopped batch translation job.

    • JobStatus — (String)

      The status of the designated job. Upon successful completion, the job's status will be STOPPED.

      Possible values include:
      • "SUBMITTED"
      • "IN_PROGRESS"
      • "COMPLETED"
      • "COMPLETED_WITH_ERROR"
      • "FAILED"
      • "STOP_REQUESTED"
      • "STOPPED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
translate.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the given Amazon Translate resource to which you want to associate the tags.

  • Tags — (Array<map>)

    Tags being associated with a specific Amazon Translate resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

    • Key — required — (String)

      The initial part of a key-value pair that forms a tag associated with a given resource.

    • Value — required — (String)

      The second part of a key-value pair that forms a tag associated with a given resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  Document: { /* required */
    Content: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
    ContentType: 'STRING_VALUE' /* required */
  },
  SourceLanguageCode: 'STRING_VALUE', /* required */
  TargetLanguageCode: 'STRING_VALUE', /* required */
  Settings: {
    Brevity: ON,
    Formality: FORMAL | INFORMAL,
    Profanity: MASK
  },
  TerminologyNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
translate.translateDocument(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Document — (map)

    The content and content type for the document to be translated. The document size must not exceed 100 KB.

    • Content — required — (Buffer, Typed Array, Blob, String)

      The Contentfield type is Binary large object (blob). This object contains the document content converted into base64-encoded binary data. If you use one of the AWS SDKs, the SDK performs the Base64-encoding on this field before sending the request.

    • ContentType — required — (String)

      Describes the format of the document. You can specify one of the following:

      • text/html - The input data consists of HTML content. Amazon Translate translates only the text in the HTML element.

      • text/plain - The input data consists of unformatted text. Amazon Translate translates every character in the content.

      • application/vnd.openxmlformats-officedocument.wordprocessingml.document - The input data consists of a Word document (.docx).

  • TerminologyNames — (Array<String>)

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

  • SourceLanguageCode — (String)

    The language code for the language of the source text. For a list of supported language codes, see Supported 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.

    Note: If you specify auto, you must send the TranslateDocument request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
  • TargetLanguageCode — (String)

    The language code requested for the translated document. For a list of supported language codes, see Supported languages.

  • Settings — (map)

    Settings to configure your translation output. You can configure the following options:

    • Brevity: not supported.

    • Formality: sets the formality level of the output text.

    • Profanity: masks profane words and phrases in your 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.

      Possible values include:
      • "FORMAL"
      • "INFORMAL"
    • 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.

      Possible values include:
      • "MASK"
    • 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.

      Possible values include:
      • "ON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TranslatedDocument — (map)

      The document containing the translated content. The document format matches the source document format.

      • Content — required — (Buffer, Typed Array, Blob, String)

        The document containing the translated content.

    • SourceLanguageCode — (String)

      The language code of the source document.

    • TargetLanguageCode — (String)

      The language code of the translated document.

    • AppliedTerminologies — (Array<map>)

      The names of the custom terminologies applied to the input text by Amazon Translate to produce the translated text document.

      • Name — (String)

        The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

      • Terms — (Array<map>)

        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.

        • 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 — (map)

      Settings to configure your translation output. You can configure the following options:

      • Brevity: reduces the length of the translation output for most translations. Available for TranslateText only.

      • Formality: sets the formality level of the translation output.

      • Profanity: masks profane words and phrases in 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.

        Possible values include:
        • "FORMAL"
        • "INFORMAL"
      • 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.

        Possible values include:
        • "MASK"
      • 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.

        Possible values include:
        • "ON"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  SourceLanguageCode: 'STRING_VALUE', /* required */
  TargetLanguageCode: 'STRING_VALUE', /* required */
  Text: 'STRING_VALUE', /* required */
  Settings: {
    Brevity: ON,
    Formality: FORMAL | INFORMAL,
    Profanity: MASK
  },
  TerminologyNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
translate.translateText(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Text — (String)

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

  • TerminologyNames — (Array<String>)

    The name of a terminology list file to add to the translation job. This file provides source terms and the desired translation for each term. A terminology list can contain a maximum of 256 terms. You can use one custom terminology resource in your translation request.

    Use the ListTerminologies operation to get the available terminology lists.

    For more information about custom terminology lists, see Custom terminology.

  • SourceLanguageCode — (String)

    The language code for the language of the source text. For a list of language codes, see Supported 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.

    Note: If you specify auto, you must send the TranslateText request in a region that supports Amazon Comprehend. Otherwise, the request returns an error indicating that autodetect is not supported.
  • TargetLanguageCode — (String)

    The language code requested for the language of the target text. For a list of language codes, see Supported languages.

  • Settings — (map)

    Settings to configure your translation output. You can configure the following options:

    • Brevity: reduces the length of the translated output for most translations.

    • Formality: sets the formality level of the output text.

    • Profanity: masks profane words and phrases in your 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.

      Possible values include:
      • "FORMAL"
      • "INFORMAL"
    • 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.

      Possible values include:
      • "MASK"
    • 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.

      Possible values include:
      • "ON"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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 — (Array<map>)

      The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

      • Name — (String)

        The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

      • Terms — (Array<map>)

        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.

        • 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 — (map)

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

        Possible values include:
        • "FORMAL"
        • "INFORMAL"
      • 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.

        Possible values include:
        • "MASK"
      • 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.

        Possible values include:
        • "ON"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
translate.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) of the given Amazon Translate resource from which you want to remove the tags.

  • TagKeys — (Array<String>)

    The initial part of a key-value pair that forms a tag being removed from a given resource. Keys must be unique and cannot be duplicated for a particular resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ParallelDataConfig: { /* required */
    Format: TSV | CSV | TMX,
    S3Uri: 'STRING_VALUE'
  },
  Description: 'STRING_VALUE'
};
translate.updateParallelData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Name — (String)

    The name of the parallel data resource being updated.

  • Description — (String)

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

  • ParallelDataConfig — (map)

    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.

      Possible values include:
      • "TSV"
      • "CSV"
      • "TMX"
  • ClientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "ACTIVE"
      • "DELETING"
      • "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.

      Possible values include:
      • "CREATING"
      • "UPDATING"
      • "ACTIVE"
      • "DELETING"
      • "FAILED"
    • LatestUpdateAttemptAt — (Date)

      The time that the most recent update was attempted.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.