- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
TranslateClient
Provides translation of the input content from the source language to the target language.
Installation
npm install @aws-sdk/client-translateyarn add @aws-sdk/client-translatepnpm add @aws-sdk/client-translateTranslateClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| CreateParallelDataCommand | 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. |
| DeleteParallelDataCommand | Deletes a parallel data resource in Amazon Translate. |
| DeleteTerminologyCommand | A synchronous action that deletes a custom terminology. |
| DescribeTextTranslationJobCommand | 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. |
| GetParallelDataCommand | Provides information about a parallel data resource. |
| GetTerminologyCommand | Retrieves a custom terminology. |
| ImportTerminologyCommand | Creates or updates a custom terminology, depending on whether 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. The only supported merge strategy is OVERWRITE, where the imported terminology overwrites the existing terminology of the same name. If you import a terminology that overwrites an existing one, the new terminology takes up to 10 minutes to fully propagate. After that, translations have access to the new terminology. |
| ListLanguagesCommand | Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports. |
| ListParallelDataCommand | Provides a list of your parallel data resources in Amazon Translate. |
| ListTagsForResourceCommand | Lists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources . |
| ListTerminologiesCommand | Provides a list of custom terminologies associated with your account. |
| ListTextTranslationJobsCommand | Gets a list of the batch translation jobs that you have submitted. |
| StartTextTranslationJobCommand | Starts an asynchronous batch translation job. Use batch translation jobs to translate large volumes of text across multiple documents at once. For batch translation, you can input documents with different source languages (specify Batch translation jobs can be described with the DescribeTextTranslationJob operation, listed with the ListTextTranslationJobs operation, and stopped with the StopTextTranslationJob operation. |
| StopTextTranslationJobCommand | Stops an asynchronous batch translation job that is in progress. If the job's state is 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 |
| TagResourceCommand | Associates a specific tag with a resource. A tag is a key-value pair that adds as a metadata to a resource. For more information, see Tagging your resources . |
| TranslateDocumentCommand | Translates the input document from the source language to the target language. This synchronous operation supports text, HTML, or Word documents as the input document. If you set the |
| TranslateTextCommand | Translates input text from the source language to the target language. For a list of available languages and language codes, see Supported languages . |
| UntagResourceCommand | Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources . |
| UpdateParallelDataCommand | Updates a previously created parallel data resource by importing a new input file from Amazon S3. |
TranslateClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: TranslateClientConfig