You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Translate

Inherits:

AWS.Service

Object
AWS.Service
AWS.Translate

show all

Identifier:: translate

API Version:: 2017-07-01

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Provides translation between one source language and another of the same set of languages.

Sending a Request Using Translate

var translate = new AWS.Translate();
translate.createParallelData(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Translate object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var translate = new AWS.Translate({apiVersion: '2017-07-01'});

You can also set the API version globally in AWS.config.apiVersions using the translate service identifier:

AWS.config.apiVersions = {
  translate: '2017-07-01',
  // other service API versions
};

var translate = new AWS.Translate();

Version:

2017-07-01

Constructor Summary collapse

new AWS.Translate(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

createParallelData(params = {}, callback) ⇒ AWS.Request
Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3.
deleteParallelData(params = {}, callback) ⇒ AWS.Request
Deletes a parallel data resource in Amazon Translate.

.
deleteTerminology(params = {}, callback) ⇒ AWS.Request
A synchronous action that deletes a custom terminology.

.
describeTextTranslationJob(params = {}, callback) ⇒ AWS.Request
Gets the properties associated with an asynchronous batch translation job including name, ID, status, source and target languages, input/output S3 buckets, and so on.

.
getParallelData(params = {}, callback) ⇒ AWS.Request
Provides information about a parallel data resource.

.
getTerminology(params = {}, callback) ⇒ AWS.Request
Retrieves a custom terminology.

.
importTerminology(params = {}, callback) ⇒ AWS.Request
Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
listParallelData(params = {}, callback) ⇒ AWS.Request
Provides a list of your parallel data resources in Amazon Translate.

.
listTerminologies(params = {}, callback) ⇒ AWS.Request
Provides a list of custom terminologies associated with your account.

.
listTextTranslationJobs(params = {}, callback) ⇒ AWS.Request
Gets a list of the batch translation jobs that you have submitted.

.
startTextTranslationJob(params = {}, callback) ⇒ AWS.Request
Starts an asynchronous batch translation job.
stopTextTranslationJob(params = {}, callback) ⇒ AWS.Request
Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state.
translateText(params = {}, callback) ⇒ AWS.Request
Translates input text from the source language to the target language.
updateParallelData(params = {}, callback) ⇒ AWS.Request
Updates a previously created parallel data resource by importing a new input file from Amazon S3.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Translate(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Translate object

var translate = new AWS.Translate({apiVersion: '2017-07-01'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.Translate.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.Translate.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.Translate.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

createParallelData(params = {}, callback) ⇒ `AWS.Request`

Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples that show how you want segments of text to be translated. By adding parallel data, you can influence the style, tone, and word choice in your translation output.

Service Reference:

CreateParallelData

Examples:

Calling the createParallelData operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ParallelDataConfig: { /* required */
    Format: TSV | CSV | TMX, /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  EncryptionKey: {
    Id: 'STRING_VALUE', /* required */
    Type: KMS /* required */
  }
};
translate.createParallelData(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)
  A custom name for the parallel data resource in Amazon Translate. You must assign a name that is unique in the account and region.
- 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 — required — (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 — required — (String)
    The format of the parallel data input file.
    Possible values include:
    - "TSV"
    - "CSV"
    - "TMX"
- EncryptionKey — (map)
  The encryption key used to encrypt this object.
  - Type — required — (String)
    The type of encryption key used by Amazon Translate to encrypt custom terminologies.
    Possible values include:
    - "KMS"
  - Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
- 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 custom name that you assigned to the parallel data resource.
  - Status — (String)
    The status of the parallel data resource. When the resource is ready for you to use, the status is ACTIVE.
    Possible values include:
    
    "CREATING"
    
    "UPDATING"
    
    "ACTIVE"
    
    "DELETING"
    
    "FAILED"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteParallelData(params = {}, callback) ⇒ `AWS.Request`

Deletes a parallel data resource in Amazon Translate.

Service Reference:

DeleteParallelData

Examples:

Calling the deleteParallelData operation

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.

deleteTerminology(params = {}, callback) ⇒ `AWS.Request`

A synchronous action that deletes a custom terminology.

Service Reference:

DeleteTerminology

Examples:

Calling the deleteTerminology operation

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.

describeTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

DescribeTextTranslationJob

Examples:

Calling the describeTextTranslationJob operation

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 file. 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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getParallelData(params = {}, callback) ⇒ `AWS.Request`

Provides information about a parallel data resource.

Service Reference:

GetParallelData

Examples:

Calling the getParallelData operation

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 — required — (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 — required — (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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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 parallel data 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 a parallel data 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 parallel data 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 a parallel data 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 parallel data 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 a parallel data 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 parallel data 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 a parallel data 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.

getTerminology(params = {}, callback) ⇒ `AWS.Request`

Retrieves a custom terminology.

Service Reference:

GetTerminology

Examples:

Calling the getTerminology operation

var params = {
  Name: 'STRING_VALUE', /* required */
  TerminologyDataFormat: CSV | TMX /* required */
};
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, either CSV or TMX.
  Possible values include:
  - "CSV"
  - "TMX"

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 file. 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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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.
  - TerminologyDataLocation — (map)
    The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.
    
    RepositoryType — required — (String)
    The repository type for the custom terminology data.
    
    Location — required — (String)
    The location of the custom terminology data.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

importTerminology(params = {}, callback) ⇒ `AWS.Request`

Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

Service Reference:

ImportTerminology

Examples:

Calling the importTerminology operation

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 /* required */
  },
  Description: 'STRING_VALUE',
  EncryptionKey: {
    Id: 'STRING_VALUE', /* required */
    Type: KMS /* required */
  }
};
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. Either CSV or TMX.
    Possible values include:
    - "CSV"
    - "TMX"
- 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 custom terminologies.
    Possible values include:
    - "KMS"
  - Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.

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 file. 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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listParallelData(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

ListParallelData

Examples:

Calling the listParallelData operation

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 — required — (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 — required — (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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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.

listTerminologies(params = {}, callback) ⇒ `AWS.Request`

Provides a list of custom terminologies associated with your account.

Service Reference:

ListTerminologies

Examples:

Calling the listTerminologies operation

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 file. 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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    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.
  - 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.

listTextTranslationJobs(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

ListTextTranslationJobs

Examples:

Calling the listTextTranslationJobs operation

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 file. 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 custom terminologies.
    Possible values include:
    
    "KMS"
    
    Id — required — (String)
    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
    
    DataAccessRoleArn — (String)
    The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role that granted Amazon Translate read access to the job's input data.
  - NextToken — (String)
    The token to use to 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.

startTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

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

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

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

Service Reference:

StartTextTranslationJob

Examples:

Calling the startTextTranslationJob operation

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 */
  ],
  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 S3 location of the input documents for the translation job.
  - S3Uri — required — (String)
    The URI of the AWS S3 folder that contains the input file. The folder must be in the same Region as the API endpoint you are calling.
  - ContentType — 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 custom terminologies.
      Possible values include:
      
      "KMS"
    - Id — required — (String)
      The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.
- 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. For a list of language codes, see what-is-languages.
  
  Amazon Translate does not automatically detect a source language during batch translation jobs.
- TargetLanguageCodes — (Array<String>)
  The language code of the output language.
- 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.
  
  For a list of available custom terminology resources, use the ListTerminologies operation.
  
  For more information, see how-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. 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-translations-parallel-data.
- ClientToken — (String)
  A unique identifier for the request. This token is auto-generated when using the Amazon Translate 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:
  - 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.

stopTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

Stops an asynchronous batch translation job that is in progress.

If the job's state is IN_PROGRESS, the job will be marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state. Otherwise, the job is put into the STOPPED state.

Asynchronous batch translation jobs are started with the StartTextTranslationJob operation. You can use the DescribeTextTranslationJob or ListTextTranslationJobs operations to get a batch translation job's JobId.

Service Reference:

StopTextTranslationJob

Examples:

Calling the stopTextTranslationJob operation

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.

translateText(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

TranslateText

Examples:

Calling the translateText operation

var params = {
  SourceLanguageCode: 'STRING_VALUE', /* required */
  TargetLanguageCode: 'STRING_VALUE', /* required */
  Text: 'STRING_VALUE', /* required */
  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 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.
- TerminologyNames — (Array<String>)
  The name of the terminology list file to be used in the TranslateText request. You can use 1 terminology list at most in a TranslateText request. Terminology lists can contain a maximum of 256 terms.
- SourceLanguageCode — (String)
  The language code for the language of the source text. The language must be a language supported by Amazon Translate. For a list of language codes, see what-is-languages.
  
  To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.
- TargetLanguageCode — (String)
  The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

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.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

updateParallelData(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UpdateParallelData

Examples:

Calling the updateParallelData operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ParallelDataConfig: { /* required */
    Format: TSV | CSV | TMX, /* required */
    S3Uri: 'STRING_VALUE' /* required */
  },
  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 — required — (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 — required — (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.

Class: AWS.Translate

Overview

Service Description

Sending a Request Using Translate

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.Translate(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

createParallelData(params = {}, callback) ⇒ AWS.Request

deleteParallelData(params = {}, callback) ⇒ AWS.Request

deleteTerminology(params = {}, callback) ⇒ AWS.Request

describeTextTranslationJob(params = {}, callback) ⇒ AWS.Request

getParallelData(params = {}, callback) ⇒ AWS.Request

getTerminology(params = {}, callback) ⇒ AWS.Request

importTerminology(params = {}, callback) ⇒ AWS.Request

listParallelData(params = {}, callback) ⇒ AWS.Request

listTerminologies(params = {}, callback) ⇒ AWS.Request

listTextTranslationJobs(params = {}, callback) ⇒ AWS.Request

startTextTranslationJob(params = {}, callback) ⇒ AWS.Request

stopTextTranslationJob(params = {}, callback) ⇒ AWS.Request

translateText(params = {}, callback) ⇒ AWS.Request

updateParallelData(params = {}, callback) ⇒ AWS.Request

new AWS.Translate(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

createParallelData(params = {}, callback) ⇒ `AWS.Request`

deleteParallelData(params = {}, callback) ⇒ `AWS.Request`

deleteTerminology(params = {}, callback) ⇒ `AWS.Request`

describeTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

getParallelData(params = {}, callback) ⇒ `AWS.Request`

getTerminology(params = {}, callback) ⇒ `AWS.Request`

importTerminology(params = {}, callback) ⇒ `AWS.Request`

listParallelData(params = {}, callback) ⇒ `AWS.Request`

listTerminologies(params = {}, callback) ⇒ `AWS.Request`

listTextTranslationJobs(params = {}, callback) ⇒ `AWS.Request`

startTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

stopTextTranslationJob(params = {}, callback) ⇒ `AWS.Request`

translateText(params = {}, callback) ⇒ `AWS.Request`

updateParallelData(params = {}, callback) ⇒ `AWS.Request`