@aws-sdk/client-translate

What is @aws-sdk/client-translate?

@aws-sdk/client-translate is an AWS SDK for JavaScript package that allows developers to interact with the Amazon Translate service. This service provides real-time translation of text between multiple languages, making it useful for applications that require language translation capabilities.

What are @aws-sdk/client-translate's main functionalities?

Translate Text

This feature allows you to translate text from one language to another. The code sample demonstrates how to use the TranslateTextCommand to translate 'Hello, world!' from English to Spanish.

const { TranslateClient, TranslateTextCommand } = require('@aws-sdk/client-translate');

const client = new TranslateClient({ region: 'us-east-1' });

const translateText = async (text, sourceLang, targetLang) => {
  const command = new TranslateTextCommand({
    Text: text,
    SourceLanguageCode: sourceLang,
    TargetLanguageCode: targetLang
  });
  const response = await client.send(command);
  return response.TranslatedText;
};

translateText('Hello, world!', 'en', 'es').then(console.log).catch(console.error);

List Languages

This feature allows you to list all supported languages by Amazon Translate. The code sample demonstrates how to use the ListLanguagesCommand to retrieve and print the list of supported languages.

const { TranslateClient, ListLanguagesCommand } = require('@aws-sdk/client-translate');

const client = new TranslateClient({ region: 'us-east-1' });

const listLanguages = async () => {
  const command = new ListLanguagesCommand({});
  const response = await client.send(command);
  return response.Languages;
};

listLanguages().then(console.log).catch(console.error);

Other packages similar to @aws-sdk/client-translate

google-translate-api

The google-translate-api package provides an interface to the Google Translate service. It offers similar functionalities such as text translation between multiple languages. However, it uses Google's translation service instead of AWS's, and it may have different language support and pricing models.

microsoft-cognitiveservices-speech-sdk

The microsoft-cognitiveservices-speech-sdk package provides access to Microsoft's Cognitive Services, including translation services. It offers functionalities for text and speech translation, making it a more comprehensive solution for applications that require both text and speech translation capabilities. It uses Microsoft's translation service, which may have different language support and pricing models compared to AWS.

README

@aws-sdk/client-translate

Description

AWS SDK for JavaScript Translate Client for Node.js, Browser and React Native.

Provides translation of the input content from the source language to the target language.

Installing

To install this package, simply type add or install @aws-sdk/client-translate using your favorite package manager:

• npm install @aws-sdk/client-translate
• yarn add @aws-sdk/client-translate
• pnpm add @aws-sdk/client-translate

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the TranslateClient and the commands you need, for example ListLanguagesCommand:

// ES5 example
const { TranslateClient, ListLanguagesCommand } = require("@aws-sdk/client-translate");

// ES6+ example
import { TranslateClient, ListLanguagesCommand } from "@aws-sdk/client-translate";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new TranslateClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListLanguagesCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-translate";
const client = new AWS.Translate({ region: "REGION" });

// async/await.
try {
  const data = await client.listLanguages(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listLanguages(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listLanguages(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-translate package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CreateParallelData

Command API Reference / Input / Output

DeleteParallelData

Command API Reference / Input / Output

DeleteTerminology

Command API Reference / Input / Output

DescribeTextTranslationJob

Command API Reference / Input / Output

GetParallelData

Command API Reference / Input / Output

GetTerminology

Command API Reference / Input / Output

ImportTerminology

Command API Reference / Input / Output

ListLanguages

Command API Reference / Input / Output

ListParallelData

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTerminologies

Command API Reference / Input / Output

ListTextTranslationJobs

Command API Reference / Input / Output

StartTextTranslationJob

Command API Reference / Input / Output

StopTextTranslationJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TranslateDocument

Command API Reference / Input / Output

TranslateText

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateParallelData

Command API Reference / Input / Output

Changelog

3.699.0 (2024-11-22)

Bug Fixes

• credential-provider-ini: pass clientConfig to sso and sso-oidc inner clients (#6688) (0ca3da3)

Features

• client-auto-scaling: Now, Amazon EC2 Auto Scaling customers can enable target tracking policies to take quicker scaling decisions, enhancing their application performance and EC2 utilization. To get started, specify target tracking to monitor a metric that is available on Amazon CloudWatch at seconds-level interval. (26d5f85)
• client-bcm-pricing-calculator: Initial release of the AWS Billing and Cost Management Pricing Calculator API. (13fd8a4)
• client-bedrock-agent-runtime: InvokeInlineAgent API release to help invoke runtime agents without any dependency on preconfigured agents. (372482a)
• client-chatbot: Adds support for programmatic management of custom actions and aliases which can be associated with channel configurations. (acdb624)
• client-codepipeline: AWS CodePipeline V2 type pipelines now support ECRBuildAndPublish and InspectorScan actions. (cce4188)
• client-cognito-identity-provider: Add support for users to sign up and sign in without passwords, using email and SMS OTPs and Passkeys. Add support for Passkeys based on WebAuthn. Add support for enhanced branding customization for hosted authentication pages with Amazon Cognito Managed Login. Add feature tiers with new pricing. (3ef966f)
• client-connect: Amazon Connect Service Feature: Add APIs for Amazon Connect Email Channel (a83926c)
• client-cost-explorer: This release adds the Impact field(contains Contribution field) to the GetAnomalies API response under RootCause (af7c9b2)
• client-elastic-load-balancing-v2: This release adds support for advertising trusted CA certificate names in associated trust stores. (5e46efc)
• client-emr: Advanced Scaling in Amazon EMR Managed Scaling (4092279)
• client-inspector2: Extend inspector2 service model to include ServiceQuotaExceededException. (dc13e07)
• client-lambda: Add ProvisionedPollerConfig to Lambda event-source-mapping API. (511ab41)
• client-mailmanager: Added new "DeliverToQBusiness" rule action to MailManager RulesSet for ingesting email data into Amazon Q Business customer applications (048d165)
• client-neptune-graph: Add 4 new APIs to support new Export features, allowing Parquet and CSV formats. Add new arguments in Import APIs to support Parquet import. Add a new query "neptune.read" to run algorithms without loading data into database (48054dc)
• client-omics: This release adds support for resource policy based cross account S3 access to sequence store read sets. (dbe3f07)
• client-quicksight: This release includes: Update APIs to support Image, Layer Map, font customization, and Plugin Visual. Add Identity center related information in ListNamsespace API. Update API for restrictedFolder support in topics and add API for SearchTopics, Describe/Update DashboardsQA Configration. (df75ca5)
• client-sagemaker: This release adds APIs for new features for SageMaker endpoint to scale down to zero instances, native support for multi-adapter inference, and endpoint scaling improvements. (f082da5)
• client-ses: This release adds support for starting email contacts in your Amazon Connect instance as an email receiving action. (14fc94c)
• client-sfn: Add support for variables and JSONata in TestState, GetExecutionHistory, DescribeStateMachine, and DescribeStateMachineForExecution (c9c278a)
• clients: update client endpoints as of 2024-11-22 (bcd27a2)