com.amazonaws.services.translate

Class AmazonTranslateClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.translate.AmazonTranslateClient

All Implemented Interfaces:

AmazonTranslate

Direct Known Subclasses:

AmazonTranslateAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonTranslateClient
extends AmazonWebServiceClient
implements AmazonTranslate

Client for accessing Amazon Translate. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.translate.AmazonTranslate

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonTranslateClientBuilder	builder()
CreateParallelDataResult	createParallelData(CreateParallelDataRequest request) Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3.
DeleteParallelDataResult	deleteParallelData(DeleteParallelDataRequest request) Deletes a parallel data resource in Amazon Translate.
DeleteTerminologyResult	deleteTerminology(DeleteTerminologyRequest request) A synchronous action that deletes a custom terminology.
DescribeTextTranslationJobResult	describeTextTranslationJob(DescribeTextTranslationJobRequest 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.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetParallelDataResult	getParallelData(GetParallelDataRequest request) Provides information about a parallel data resource.
GetTerminologyResult	getTerminology(GetTerminologyRequest request) Retrieves a custom terminology.
ImportTerminologyResult	importTerminology(ImportTerminologyRequest request) Creates or updates a custom terminology, depending on whether one already exists for the given terminology name.
ListLanguagesResult	listLanguages(ListLanguagesRequest request) Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.
ListParallelDataResult	listParallelData(ListParallelDataRequest request) Provides a list of your parallel data resources in Amazon Translate.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags associated with a given Amazon Translate resource.
ListTerminologiesResult	listTerminologies(ListTerminologiesRequest request) Provides a list of custom terminologies associated with your account.
ListTextTranslationJobsResult	listTextTranslationJobs(ListTextTranslationJobsRequest request) Gets a list of the batch translation jobs that you have submitted.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartTextTranslationJobResult	startTextTranslationJob(StartTextTranslationJobRequest request) Starts an asynchronous batch translation job.
StopTextTranslationJobResult	stopTextTranslationJob(StopTextTranslationJobRequest request) Stops an asynchronous batch translation job that is in progress.
TagResourceResult	tagResource(TagResourceRequest request) Associates a specific tag with a resource.
TranslateDocumentResult	translateDocument(TranslateDocumentRequest request) Translates the input document from the source language to the target language.
TranslateTextResult	translateText(TranslateTextRequest request) Translates input text from the source language to the target language.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a specific tag associated with an Amazon Translate resource.
UpdateParallelDataResult	updateParallelData(UpdateParallelDataRequest request) Updates a previously created parallel data resource by importing a new input file from Amazon S3.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonTranslateClientBuilder builder()

createParallelData

public CreateParallelDataResult createParallelData(CreateParallelDataRequest 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.

Specified by:

createParallelData in interface AmazonTranslate

Parameters:

createParallelDataRequest -

Returns:

Result of the CreateParallelData operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

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.

TooManyTagsException - You have added too many tags to this resource. The maximum is 50 tags.

ConflictException - There was a conflict processing the request. Try your request again.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

deleteParallelData

public DeleteParallelDataResult deleteParallelData(DeleteParallelDataRequest request)

Deletes a parallel data resource in Amazon Translate.

Specified by:

deleteParallelData in interface AmazonTranslate

Parameters:

deleteParallelDataRequest -

Returns:

Result of the DeleteParallelData operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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.

See Also:

AWS API Documentation

deleteTerminology

public DeleteTerminologyResult deleteTerminology(DeleteTerminologyRequest request)

A synchronous action that deletes a custom terminology.

Specified by:

deleteTerminology in interface AmazonTranslate

Parameters:

deleteTerminologyRequest -

Returns:

Result of the DeleteTerminology operation returned by the service.

Throws:

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.

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

describeTextTranslationJob

public DescribeTextTranslationJobResult describeTextTranslationJob(DescribeTextTranslationJobRequest 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.

Specified by:

describeTextTranslationJob in interface AmazonTranslate

Parameters:

describeTextTranslationJobRequest -

Returns:

Result of the DescribeTextTranslationJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getParallelData

public GetParallelDataResult getParallelData(GetParallelDataRequest request)

Provides information about a parallel data resource.

Specified by:

getParallelData in interface AmazonTranslate

Parameters:

getParallelDataRequest -

Returns:

Result of the GetParallelData operation returned by the service.

Throws:

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 not valid. 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.

See Also:

AWS API Documentation

getTerminology

public GetTerminologyResult getTerminology(GetTerminologyRequest request)

Retrieves a custom terminology.

Specified by:

getTerminology in interface AmazonTranslate

Parameters:

getTerminologyRequest -

Returns:

Result of the GetTerminology operation returned by the service.

Throws:

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 not valid. 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.

See Also:

AWS API Documentation

importTerminology

public ImportTerminologyResult importTerminology(ImportTerminologyRequest request)

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.

Specified by:

importTerminology in interface AmazonTranslate

Parameters:

importTerminologyRequest -

Returns:

Result of the ImportTerminology operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. 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.

TooManyTagsException - You have added too many tags to this resource. The maximum is 50 tags.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listLanguages

public ListLanguagesResult listLanguages(ListLanguagesRequest request)

Provides a list of languages (RFC-5646 codes and names) that Amazon Translate supports.

Specified by:

listLanguages in interface AmazonTranslate

Parameters:

listLanguagesRequest -

Returns:

Result of the ListLanguages operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. 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.

UnsupportedDisplayLanguageCodeException - Requested display language code is not supported.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

listParallelData

public ListParallelDataResult listParallelData(ListParallelDataRequest request)

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

Specified by:

listParallelData in interface AmazonTranslate

Parameters:

listParallelDataRequest -

Returns:

Result of the ListParallelData operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. 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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags associated with a given Amazon Translate resource. For more information, see Tagging your resources.

Specified by:

listTagsForResource in interface AmazonTranslate

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

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.

See Also:

AWS API Documentation

listTerminologies

public ListTerminologiesResult listTerminologies(ListTerminologiesRequest request)

Provides a list of custom terminologies associated with your account.

Specified by:

listTerminologies in interface AmazonTranslate

Parameters:

listTerminologiesRequest -

Returns:

Result of the ListTerminologies operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. 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.

See Also:

AWS API Documentation

listTextTranslationJobs

public ListTextTranslationJobsResult listTextTranslationJobs(ListTextTranslationJobsRequest request)

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

Specified by:

listTextTranslationJobs in interface AmazonTranslate

Parameters:

listTextTranslationJobsRequest -

Returns:

Result of the ListTextTranslationJobs operation returned by the service.

Throws:

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid and then retry the 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.

InvalidFilterException - The filter specified for the operation is not valid. Specify a different filter.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

startTextTranslationJob

public StartTextTranslationJobResult startTextTranslationJob(StartTextTranslationJobRequest request)

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 auto as the source language). You can specify one or more target languages. Batch translation translates each input document into each of the target languages. For more information, see Asynchronous batch processing.

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

Specified by:

startTextTranslationJob in interface AmazonTranslate

Parameters:

startTextTranslationJobRequest -

Returns:

Result of the StartTextTranslationJob operation returned by the service.

Throws:

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 Supported languages.

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

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 not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

stopTextTranslationJob

public StopTextTranslationJobResult stopTextTranslationJob(StopTextTranslationJobRequest 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.

Specified by:

stopTextTranslationJob in interface AmazonTranslate

Parameters:

stopTextTranslationJobRequest -

Returns:

Result of the StopTextTranslationJob operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonTranslate

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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.

TooManyTagsException - You have added too many tags to this resource. The maximum is 50 tags.

InternalServerException - An internal server error occurred. Retry your request.

See Also:

AWS API Documentation

translateDocument

public TranslateDocumentResult translateDocument(TranslateDocumentRequest request)

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. TranslateDocument supports translations from English to any supported language, and from any supported language to English. Therefore, specify either the source language code or the target language code as “en” (English).

If you set the Formality parameter, the request will fail if the target language does not support formality. For a list of target languages that support formality, see Setting formality.

Specified by:

translateDocument in interface AmazonTranslate

Parameters:

translateDocumentRequest -

Returns:

Result of the TranslateDocument operation returned by the service.

Throws:

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

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.

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.

UnsupportedLanguagePairException - Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see Supported languages.

InternalServerException - An internal server error occurred. Retry your request.

ServiceUnavailableException - The Amazon Translate service is temporarily unavailable. Wait a bit and then retry your request.

See Also:

AWS API Documentation

translateText

public TranslateTextResult translateText(TranslateTextRequest request)

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

Specified by:

translateText in interface AmazonTranslate

Parameters:

translateTextRequest -

Returns:

Result of the TranslateText operation returned by the service.

Throws:

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid 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 Supported languages.

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. Wait a bit and then retry your request.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a specific tag associated with an Amazon Translate resource. For more information, see Tagging your resources.

Specified by:

untagResource in interface AmazonTranslate

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

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.

See Also:

AWS API Documentation

updateParallelData

public UpdateParallelDataResult updateParallelData(UpdateParallelDataRequest request)

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

Specified by:

updateParallelData in interface AmazonTranslate

Parameters:

updateParallelDataRequest -

Returns:

Result of the UpdateParallelData operation returned by the service.

Throws:

ConcurrentModificationException - Another modification is being made. That modification must complete before you can make your change.

InvalidParameterValueException - The value of the parameter is not valid. Review the value of the parameter you are using to correct it, and then retry your operation.

InvalidRequestException - The request that you made is not valid. Check your request to determine why it's not valid and then retry the request.

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.

ConflictException - There was a conflict processing the request. Try your request again.

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonTranslate

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonTranslate

Overrides:

shutdown in class AmazonWebServiceClient