com.amazonaws.services.translate

Interface AmazonTranslate

All Known Subinterfaces:

AmazonTranslateAsync

All Known Implementing Classes:

AbstractAmazonTranslate, AbstractAmazonTranslateAsync, AmazonTranslateAsyncClient, AmazonTranslateClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonTranslate

Interface for accessing Amazon Translate.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonTranslate instead.

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	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DeleteTerminologyResult	deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
DescribeTextTranslationJobResult	describeTextTranslationJob(DescribeTextTranslationJobRequest describeTextTranslationJobRequest) Gets the properties associated with an asycnhronous 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.
GetTerminologyResult	getTerminology(GetTerminologyRequest getTerminologyRequest) Retrieves a custom terminology.
ImportTerminologyResult	importTerminology(ImportTerminologyRequest importTerminologyRequest) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
ListTerminologiesResult	listTerminologies(ListTerminologiesRequest listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
ListTextTranslationJobsResult	listTextTranslationJobs(ListTextTranslationJobsRequest listTextTranslationJobsRequest) 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 startTextTranslationJobRequest) Starts an asynchronous batch translation job.
StopTextTranslationJobResult	stopTextTranslationJob(StopTextTranslationJobRequest stopTextTranslationJobRequest) Stops an asynchronous batch translation job that is in progress.
TranslateTextResult	translateText(TranslateTextRequest translateTextRequest) Translates input text from the source language to the target language.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

deleteTerminology

DeleteTerminologyResult deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)

A synchronous action that deletes a custom terminology.

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.

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

See Also:

AWS API Documentation

describeTextTranslationJob

DescribeTextTranslationJobResult describeTextTranslationJob(DescribeTextTranslationJobRequest describeTextTranslationJobRequest)

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

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

getTerminology

GetTerminologyResult getTerminology(GetTerminologyRequest getTerminologyRequest)

Retrieves a custom terminology.

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

See Also:

AWS API Documentation

importTerminology

ImportTerminologyResult 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:

Result of the ImportTerminology operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTerminologies

ListTerminologiesResult listTerminologies(ListTerminologiesRequest listTerminologiesRequest)

Provides a list of custom terminologies associated with your account.

Parameters:

listTerminologiesRequest -

Returns:

Result of the ListTerminologies operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTextTranslationJobs

ListTextTranslationJobsResult listTextTranslationJobs(ListTextTranslationJobsRequest listTextTranslationJobsRequest)

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

Parameters:

listTextTranslationJobsRequest -

Returns:

Result of the ListTextTranslationJobs operation returned by the service.

Throws:

InvalidRequestException - The request that you made is invalid. Check your request to determine why it's invalid 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 invalid. Specify a different filter.

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

See Also:

AWS API Documentation

startTextTranslationJob

StartTextTranslationJobResult startTextTranslationJob(StartTextTranslationJobRequest startTextTranslationJobRequest)

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.

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

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 how-to-error-msg.

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

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

See Also:

AWS API Documentation

stopTextTranslationJob

StopTextTranslationJobResult stopTextTranslationJob(StopTextTranslationJobRequest stopTextTranslationJobRequest)

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.

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

translateText

TranslateTextResult translateText(TranslateTextRequest translateTextRequest)

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

Parameters:

translateTextRequest -

Returns:

Result of the TranslateText operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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