software.amazon.awssdk.services.translate

Interface TranslateAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface TranslateAsyncClient
extends SdkClient

Service client for accessing Amazon Translate asynchronously. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static TranslateAsyncClientBuilder	builder() Create a builder that can be used to configure and create a TranslateAsyncClient.
static TranslateAsyncClient	create() Create a TranslateAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<DeleteTerminologyResponse>	deleteTerminology(Consumer<DeleteTerminologyRequest.Builder> deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
default CompletableFuture<DeleteTerminologyResponse>	deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
default CompletableFuture<GetTerminologyResponse>	getTerminology(Consumer<GetTerminologyRequest.Builder> getTerminologyRequest) Retrieves a custom terminology.
default CompletableFuture<GetTerminologyResponse>	getTerminology(GetTerminologyRequest getTerminologyRequest) Retrieves a custom terminology.
default CompletableFuture<ImportTerminologyResponse>	importTerminology(Consumer<ImportTerminologyRequest.Builder> importTerminologyRequest) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
default CompletableFuture<ImportTerminologyResponse>	importTerminology(ImportTerminologyRequest importTerminologyRequest) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
default CompletableFuture<ListTerminologiesResponse>	listTerminologies() Provides a list of custom terminologies associated with your account.
default CompletableFuture<ListTerminologiesResponse>	listTerminologies(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default CompletableFuture<ListTerminologiesResponse>	listTerminologies(ListTerminologiesRequest listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default CompletableFuture<TranslateTextResponse>	translateText(Consumer<TranslateTextRequest.Builder> translateTextRequest) Translates input text from the source language to the target language.
default CompletableFuture<TranslateTextResponse>	translateText(TranslateTextRequest translateTextRequest) Translates input text from the source language to the target language.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static TranslateAsyncClient create()

Create a TranslateAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static TranslateAsyncClientBuilder builder()

Create a builder that can be used to configure and create a TranslateAsyncClient.

deleteTerminology

default CompletableFuture<DeleteTerminologyResponse> deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)

A synchronous action that deletes a custom terminology.

Parameters:

deleteTerminologyRequest -

Returns:

A Java Future containing the result of the DeleteTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

deleteTerminology

default CompletableFuture<DeleteTerminologyResponse> deleteTerminology(Consumer<DeleteTerminologyRequest.Builder> deleteTerminologyRequest)

A synchronous action that deletes a custom terminology.

This is a convenience which creates an instance of the DeleteTerminologyRequest.Builder avoiding the need to create one manually via DeleteTerminologyRequest.builder()

Parameters:

deleteTerminologyRequest - A Consumer that will call methods on DeleteTerminologyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getTerminology

default CompletableFuture<GetTerminologyResponse> getTerminology(GetTerminologyRequest getTerminologyRequest)

Retrieves a custom terminology.

Parameters:

getTerminologyRequest -

Returns:

A Java Future containing the result of the GetTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

getTerminology

default CompletableFuture<GetTerminologyResponse> getTerminology(Consumer<GetTerminologyRequest.Builder> getTerminologyRequest)

Retrieves a custom terminology.

This is a convenience which creates an instance of the GetTerminologyRequest.Builder avoiding the need to create one manually via GetTerminologyRequest.builder()

Parameters:

getTerminologyRequest - A Consumer that will call methods on GetTerminologyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the GetTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

importTerminology

default CompletableFuture<ImportTerminologyResponse> importTerminology(ImportTerminologyRequest importTerminologyRequest)

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.

Parameters:

importTerminologyRequest -

Returns:

A Java Future containing the result of the ImportTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• LimitExceededException The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

importTerminology

default CompletableFuture<ImportTerminologyResponse> importTerminology(Consumer<ImportTerminologyRequest.Builder> importTerminologyRequest)

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.

This is a convenience which creates an instance of the ImportTerminologyRequest.Builder avoiding the need to create one manually via ImportTerminologyRequest.builder()

Parameters:

importTerminologyRequest - A Consumer that will call methods on ImportTerminologyRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ImportTerminology operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• LimitExceededException The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTerminologies

default CompletableFuture<ListTerminologiesResponse> listTerminologies(ListTerminologiesRequest listTerminologiesRequest)

Provides a list of custom terminologies associated with your account.

Parameters:

listTerminologiesRequest -

Returns:

A Java Future containing the result of the ListTerminologies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTerminologies

default CompletableFuture<ListTerminologiesResponse> listTerminologies(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest)

Provides a list of custom terminologies associated with your account.

This is a convenience which creates an instance of the ListTerminologiesRequest.Builder avoiding the need to create one manually via ListTerminologiesRequest.builder()

Parameters:

listTerminologiesRequest - A Consumer that will call methods on ListTerminologiesRequest.Builder to create a request.

Returns:

A Java Future containing the result of the ListTerminologies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

listTerminologies

default CompletableFuture<ListTerminologiesResponse> listTerminologies()

Provides a list of custom terminologies associated with your account.

Returns:

A Java Future containing the result of the ListTerminologies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValueException The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• InternalServerException An internal server error occurred. Retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

translateText

default CompletableFuture<TranslateTextResponse> translateText(TranslateTextRequest translateTextRequest)

Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.

• Arabic (ar)

• Chinese (Simplified) (zh)

• Chinese (Traditional) (zh-TW)

• Czech (cs)

• Danish (da)

• Dutch (nl)

• English (en)

• Finnish (fi)

• French (fr)

• German (de)

• Hebrew (he)

• Indonesian (id)

• Italian (it)

• Japanese (ja)

• Korean (ko)

• Polish (pl)

• Portuguese (pt)

• Russian (ru)

• Spanish (es)

• Swedish (sv)

• Turkish (tr)

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.

Parameters:

translateTextRequest -

Returns:

A Java Future containing the result of the TranslateText operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• UnsupportedLanguagePairException Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see how-to-error-msg.
• DetectedLanguageLowConfidenceException The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage operation in the Amazon Comprehend Developer Guide.
• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

translateText

default CompletableFuture<TranslateTextResponse> translateText(Consumer<TranslateTextRequest.Builder> translateTextRequest)

Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.

• Arabic (ar)

• Chinese (Simplified) (zh)

• Chinese (Traditional) (zh-TW)

• Czech (cs)

• Danish (da)

• Dutch (nl)

• English (en)

• Finnish (fi)

• French (fr)

• German (de)

• Hebrew (he)

• Indonesian (id)

• Italian (it)

• Japanese (ja)

• Korean (ko)

• Polish (pl)

• Portuguese (pt)

• Russian (ru)

• Spanish (es)

• Swedish (sv)

• Turkish (tr)

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.

This is a convenience which creates an instance of the TranslateTextRequest.Builder avoiding the need to create one manually via TranslateTextRequest.builder()

Parameters:

translateTextRequest - A Consumer that will call methods on TranslateTextRequest.Builder to create a request.

Returns:

A Java Future containing the result of the TranslateText operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidRequestException The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.
• TextSizeLimitExceededException The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.
• TooManyRequestsException You have made too many requests within a short period of time. Wait for a short time and then try your request again.
• UnsupportedLanguagePairException Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see how-to-error-msg.
• DetectedLanguageLowConfidenceException The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage operation in the Amazon Comprehend Developer Guide.
• ResourceNotFoundException The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .
• InternalServerException An internal server error occurred. Retry your request.
• ServiceUnavailableException The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• TranslateException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation