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
void	deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
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.
void	setEndpoint(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.
TranslateTextResult	translateText(TranslateTextRequest translateTextRequest) Translates input text from the source language to the target language.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
          throws 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:

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

setRegion

void setRegion(Region region)
        throws 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:

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)

deleteTerminology

void deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)
                throws AmazonClientException,
                       AmazonServiceException

A synchronous action that deletes a custom terminology.

Parameters:

deleteTerminologyRequest -

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.

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.

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.

translateText

TranslateTextResult translateText(TranslateTextRequest translateTextRequest)
                           throws AmazonClientException,
                                  AmazonServiceException

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:

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.

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.