com.amazonaws.services.translate

Interface AmazonTranslate

All Known Subinterfaces:

AmazonTranslateAsync

All Known Implementing Classes:

AmazonTranslateAsyncClient, AmazonTranslateClient

public interface AmazonTranslate

Interface for accessing Amazon Translate

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

Method Summary

Modifier and Type	Method and Description
CreateParallelDataResult	createParallelData(CreateParallelDataRequest createParallelDataRequest) Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3.
DeleteParallelDataResult	deleteParallelData(DeleteParallelDataRequest deleteParallelDataRequest) Deletes a parallel data resource in Amazon Translate.
void	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.
GetParallelDataResult	getParallelData(GetParallelDataRequest getParallelDataRequest) Provides information about a parallel data resource.
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.
ListParallelDataResult	listParallelData(ListParallelDataRequest listParallelDataRequest) Provides a list of your parallel data resources in Amazon Translate.
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	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client ("https://translate.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
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.
UpdateParallelDataResult	updateParallelData(UpdateParallelDataRequest updateParallelDataRequest) Updates a previously created parallel data resource by importing a new input file from Amazon S3.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
          throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://translate.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "translate.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://translate.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "translate.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://translate.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
        throws java.lang.IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

java.lang.IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

createParallelData

CreateParallelDataResult createParallelData(CreateParallelDataRequest createParallelDataRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Creates a parallel data resource in Amazon Translate by importing an input file from Amazon S3. Parallel data files contain examples of source phrases and their translations from your translation memory. By adding parallel data, you can influence the style, tone, and word choice in your translation output.

Parameters:

createParallelDataRequest -

Returns:

createParallelDataResult The response from the CreateParallelData service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

InvalidRequestException

LimitExceededException

TooManyRequestsException

ConflictException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

deleteParallelData

DeleteParallelDataResult deleteParallelData(DeleteParallelDataRequest deleteParallelDataRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

Deletes a parallel data resource in Amazon Translate.

Parameters:

deleteParallelDataRequest -

Returns:

deleteParallelDataResult The response from the DeleteParallelData service method, as returned by Amazon Translate.

Throws:

ConcurrentModificationException

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

deleteTerminology

void deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)
                throws AmazonClientException,
                       AmazonServiceException

A synchronous action that deletes a custom terminology.

Parameters:

deleteTerminologyRequest -

Throws:

ResourceNotFoundException

TooManyRequestsException

InvalidParameterValueException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

describeTextTranslationJob

DescribeTextTranslationJobResult describeTextTranslationJob(DescribeTextTranslationJobRequest describeTextTranslationJobRequest)
                                                     throws AmazonClientException,
                                                            AmazonServiceException

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:

describeTextTranslationJobResult The response from the DescribeTextTranslationJob service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

getParallelData

GetParallelDataResult getParallelData(GetParallelDataRequest getParallelDataRequest)
                               throws AmazonClientException,
                                      AmazonServiceException

Provides information about a parallel data resource.

Parameters:

getParallelDataRequest -

Returns:

getParallelDataResult The response from the GetParallelData service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

getTerminology

GetTerminologyResult getTerminology(GetTerminologyRequest getTerminologyRequest)
                             throws AmazonClientException,
                                    AmazonServiceException

Retrieves a custom terminology.

Parameters:

getTerminologyRequest -

Returns:

getTerminologyResult The response from the GetTerminology service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

importTerminology

ImportTerminologyResult importTerminology(ImportTerminologyRequest importTerminologyRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

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:

importTerminologyResult The response from the ImportTerminology service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

LimitExceededException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

listParallelData

ListParallelDataResult listParallelData(ListParallelDataRequest listParallelDataRequest)
                                 throws AmazonClientException,
                                        AmazonServiceException

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

Parameters:

listParallelDataRequest -

Returns:

listParallelDataResult The response from the ListParallelData service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

listTerminologies

ListTerminologiesResult listTerminologies(ListTerminologiesRequest listTerminologiesRequest)
                                   throws AmazonClientException,
                                          AmazonServiceException

Provides a list of custom terminologies associated with your account.

Parameters:

listTerminologiesRequest -

Returns:

listTerminologiesResult The response from the ListTerminologies service method, as returned by Amazon Translate.

Throws:

InvalidParameterValueException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

listTextTranslationJobs

ListTextTranslationJobsResult listTextTranslationJobs(ListTextTranslationJobsRequest listTextTranslationJobsRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

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

Parameters:

listTextTranslationJobsRequest -

Returns:

listTextTranslationJobsResult The response from the ListTextTranslationJobs service method, as returned by Amazon Translate.

Throws:

InvalidRequestException

TooManyRequestsException

InvalidFilterException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

startTextTranslationJob

StartTextTranslationJobResult startTextTranslationJob(StartTextTranslationJobRequest startTextTranslationJobRequest)
                                               throws AmazonClientException,
                                                      AmazonServiceException

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:

startTextTranslationJobResult The response from the StartTextTranslationJob service method, as returned by Amazon Translate.

Throws:

TooManyRequestsException

UnsupportedLanguagePairException

InvalidRequestException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

stopTextTranslationJob

StopTextTranslationJobResult stopTextTranslationJob(StopTextTranslationJobRequest stopTextTranslationJobRequest)
                                             throws AmazonClientException,
                                                    AmazonServiceException

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:

stopTextTranslationJobResult The response from the StopTextTranslationJob service method, as returned by Amazon Translate.

Throws:

ResourceNotFoundException

TooManyRequestsException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

translateText

TranslateTextResult translateText(TranslateTextRequest translateTextRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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:

translateTextResult The response from the TranslateText service method, as returned by Amazon Translate.

Throws:

InvalidRequestException

TextSizeLimitExceededException

TooManyRequestsException

UnsupportedLanguagePairException

DetectedLanguageLowConfidenceException

ResourceNotFoundException

InternalServerException

ServiceUnavailableException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

updateParallelData

UpdateParallelDataResult updateParallelData(UpdateParallelDataRequest updateParallelDataRequest)
                                     throws AmazonClientException,
                                            AmazonServiceException

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

Parameters:

updateParallelDataRequest -

Returns:

updateParallelDataResult The response from the UpdateParallelData service method, as returned by Amazon Translate.

Throws:

ConcurrentModificationException

InvalidParameterValueException

InvalidRequestException

LimitExceededException

TooManyRequestsException

ConflictException

ResourceNotFoundException

InternalServerException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by Amazon Translate indicating either a problem with the data in the request, or a server side issue.

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.