software.amazon.awssdk.services.translate

Interface TranslateClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

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

Service client for accessing Amazon Translate. 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 TranslateClientBuilder	builder() Create a builder that can be used to configure and create a TranslateClient.
static TranslateClient	create() Create a TranslateClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteTerminologyResponse	deleteTerminology(Consumer<DeleteTerminologyRequest.Builder> deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
default DeleteTerminologyResponse	deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest) A synchronous action that deletes a custom terminology.
default DescribeTextTranslationJobResponse	describeTextTranslationJob(Consumer<DescribeTextTranslationJobRequest.Builder> 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.
default DescribeTextTranslationJobResponse	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.
default GetTerminologyResponse	getTerminology(Consumer<GetTerminologyRequest.Builder> getTerminologyRequest) Retrieves a custom terminology.
default GetTerminologyResponse	getTerminology(GetTerminologyRequest getTerminologyRequest) Retrieves a custom terminology.
default 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 ImportTerminologyResponse	importTerminology(ImportTerminologyRequest importTerminologyRequest) Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name.
default ListTerminologiesResponse	listTerminologies() Provides a list of custom terminologies associated with your account.
default ListTerminologiesResponse	listTerminologies(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default ListTerminologiesResponse	listTerminologies(ListTerminologiesRequest listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default ListTerminologiesIterable	listTerminologiesPaginator() Provides a list of custom terminologies associated with your account.
default ListTerminologiesIterable	listTerminologiesPaginator(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default ListTerminologiesIterable	listTerminologiesPaginator(ListTerminologiesRequest listTerminologiesRequest) Provides a list of custom terminologies associated with your account.
default ListTextTranslationJobsResponse	listTextTranslationJobs(Consumer<ListTextTranslationJobsRequest.Builder> listTextTranslationJobsRequest) Gets a list of the batch translation jobs that you have submitted.
default ListTextTranslationJobsResponse	listTextTranslationJobs(ListTextTranslationJobsRequest listTextTranslationJobsRequest) Gets a list of the batch translation jobs that you have submitted.
default ListTextTranslationJobsIterable	listTextTranslationJobsPaginator(Consumer<ListTextTranslationJobsRequest.Builder> listTextTranslationJobsRequest) Gets a list of the batch translation jobs that you have submitted.
default ListTextTranslationJobsIterable	listTextTranslationJobsPaginator(ListTextTranslationJobsRequest listTextTranslationJobsRequest) Gets a list of the batch translation jobs that you have submitted.
static ServiceMetadata	serviceMetadata()
default StartTextTranslationJobResponse	startTextTranslationJob(Consumer<StartTextTranslationJobRequest.Builder> startTextTranslationJobRequest) Starts an asynchronous batch translation job.
default StartTextTranslationJobResponse	startTextTranslationJob(StartTextTranslationJobRequest startTextTranslationJobRequest) Starts an asynchronous batch translation job.
default StopTextTranslationJobResponse	stopTextTranslationJob(Consumer<StopTextTranslationJobRequest.Builder> stopTextTranslationJobRequest) Stops an asynchronous batch translation job that is in progress.
default StopTextTranslationJobResponse	stopTextTranslationJob(StopTextTranslationJobRequest stopTextTranslationJobRequest) Stops an asynchronous batch translation job that is in progress.
default TranslateTextResponse	translateText(Consumer<TranslateTextRequest.Builder> translateTextRequest) Translates input text from the source language to the target language.
default 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 TranslateClient create()

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

builder

static TranslateClientBuilder builder()

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

deleteTerminology

default DeleteTerminologyResponse deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)
                                             throws ResourceNotFoundException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

deleteTerminology

default DeleteTerminologyResponse deleteTerminology(Consumer<DeleteTerminologyRequest.Builder> deleteTerminologyRequest)
                                             throws ResourceNotFoundException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

describeTextTranslationJob

default DescribeTextTranslationJobResponse describeTextTranslationJob(DescribeTextTranslationJobRequest describeTextTranslationJobRequest)
                                                               throws ResourceNotFoundException,
                                                                      TooManyRequestsException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

describeTextTranslationJob

default DescribeTextTranslationJobResponse describeTextTranslationJob(Consumer<DescribeTextTranslationJobRequest.Builder> describeTextTranslationJobRequest)
                                                               throws ResourceNotFoundException,
                                                                      TooManyRequestsException,
                                                                      InternalServerException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      TranslateException

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.

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

Parameters:

describeTextTranslationJobRequest - A Consumer that will call methods on DescribeTextTranslationJobRequest.Builder to create a request.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getTerminology

default GetTerminologyResponse getTerminology(GetTerminologyRequest getTerminologyRequest)
                                       throws ResourceNotFoundException,
                                              InvalidParameterValueException,
                                              TooManyRequestsException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

getTerminology

default GetTerminologyResponse getTerminology(Consumer<GetTerminologyRequest.Builder> getTerminologyRequest)
                                       throws ResourceNotFoundException,
                                              InvalidParameterValueException,
                                              TooManyRequestsException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              TranslateException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

importTerminology

default ImportTerminologyResponse importTerminology(ImportTerminologyRequest importTerminologyRequest)
                                             throws InvalidParameterValueException,
                                                    LimitExceededException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

importTerminology

default ImportTerminologyResponse importTerminology(Consumer<ImportTerminologyRequest.Builder> importTerminologyRequest)
                                             throws InvalidParameterValueException,
                                                    LimitExceededException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTerminologies

default ListTerminologiesResponse listTerminologies()
                                             throws InvalidParameterValueException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

Provides a list of custom terminologies associated with your account.

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.

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.

AwsServiceException

See Also:

listTerminologies(ListTerminologiesRequest), AWS API Documentation

listTerminologies

default ListTerminologiesResponse listTerminologies(ListTerminologiesRequest listTerminologiesRequest)
                                             throws InvalidParameterValueException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTerminologies

default ListTerminologiesResponse listTerminologies(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest)
                                             throws InvalidParameterValueException,
                                                    TooManyRequestsException,
                                                    InternalServerException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    TranslateException

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTerminologiesPaginator

default ListTerminologiesIterable listTerminologiesPaginator()
                                                      throws InvalidParameterValueException,
                                                             TooManyRequestsException,
                                                             InternalServerException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             TranslateException

Provides a list of custom terminologies associated with your account.

This is a variant of listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client
             .listTerminologiesPaginator(request);
     for (software.amazon.awssdk.services.translate.model.ListTerminologiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

listTerminologiesPaginator(ListTerminologiesRequest), AWS API Documentation

listTerminologiesPaginator

default ListTerminologiesIterable listTerminologiesPaginator(ListTerminologiesRequest listTerminologiesRequest)
                                                      throws InvalidParameterValueException,
                                                             TooManyRequestsException,
                                                             InternalServerException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             TranslateException

Provides a list of custom terminologies associated with your account.

This is a variant of listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client
             .listTerminologiesPaginator(request);
     for (software.amazon.awssdk.services.translate.model.ListTerminologiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation.

Parameters:

listTerminologiesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTerminologiesPaginator

default ListTerminologiesIterable listTerminologiesPaginator(Consumer<ListTerminologiesRequest.Builder> listTerminologiesRequest)
                                                      throws InvalidParameterValueException,
                                                             TooManyRequestsException,
                                                             InternalServerException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             TranslateException

Provides a list of custom terminologies associated with your account.

This is a variant of listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client
             .listTerminologiesPaginator(request);
     for (software.amazon.awssdk.services.translate.model.ListTerminologiesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.translate.paginators.ListTerminologiesIterable responses = client.listTerminologiesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTerminologies(software.amazon.awssdk.services.translate.model.ListTerminologiesRequest) operation.

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 custom iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTextTranslationJobs

default ListTextTranslationJobsResponse listTextTranslationJobs(ListTextTranslationJobsRequest listTextTranslationJobsRequest)
                                                         throws InvalidRequestException,
                                                                TooManyRequestsException,
                                                                InvalidFilterException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTextTranslationJobs

default ListTextTranslationJobsResponse listTextTranslationJobs(Consumer<ListTextTranslationJobsRequest.Builder> listTextTranslationJobsRequest)
                                                         throws InvalidRequestException,
                                                                TooManyRequestsException,
                                                                InvalidFilterException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                TranslateException

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

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

Parameters:

listTextTranslationJobsRequest - A Consumer that will call methods on ListTextTranslationJobsRequest.Builder to create a request.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTextTranslationJobsPaginator

default ListTextTranslationJobsIterable listTextTranslationJobsPaginator(ListTextTranslationJobsRequest listTextTranslationJobsRequest)
                                                                  throws InvalidRequestException,
                                                                         TooManyRequestsException,
                                                                         InvalidFilterException,
                                                                         InternalServerException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         TranslateException

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

This is a variant of listTextTranslationJobs(software.amazon.awssdk.services.translate.model.ListTextTranslationJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client.listTextTranslationJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client
             .listTextTranslationJobsPaginator(request);
     for (software.amazon.awssdk.services.translate.model.ListTextTranslationJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client.listTextTranslationJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTextTranslationJobs(software.amazon.awssdk.services.translate.model.ListTextTranslationJobsRequest) operation.

Parameters:

listTextTranslationJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

listTextTranslationJobsPaginator

default ListTextTranslationJobsIterable listTextTranslationJobsPaginator(Consumer<ListTextTranslationJobsRequest.Builder> listTextTranslationJobsRequest)
                                                                  throws InvalidRequestException,
                                                                         TooManyRequestsException,
                                                                         InvalidFilterException,
                                                                         InternalServerException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         TranslateException

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

This is a variant of listTextTranslationJobs(software.amazon.awssdk.services.translate.model.ListTextTranslationJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client.listTextTranslationJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client
             .listTextTranslationJobsPaginator(request);
     for (software.amazon.awssdk.services.translate.model.ListTextTranslationJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.translate.paginators.ListTextTranslationJobsIterable responses = client.listTextTranslationJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Note: If you prefer to have control on service calls, use the listTextTranslationJobs(software.amazon.awssdk.services.translate.model.ListTextTranslationJobsRequest) operation.

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

Parameters:

listTextTranslationJobsRequest - A Consumer that will call methods on ListTextTranslationJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

startTextTranslationJob

default StartTextTranslationJobResponse startTextTranslationJob(StartTextTranslationJobRequest startTextTranslationJobRequest)
                                                         throws TooManyRequestsException,
                                                                UnsupportedLanguagePairException,
                                                                InvalidRequestException,
                                                                ResourceNotFoundException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

startTextTranslationJob

default StartTextTranslationJobResponse startTextTranslationJob(Consumer<StartTextTranslationJobRequest.Builder> startTextTranslationJobRequest)
                                                         throws TooManyRequestsException,
                                                                UnsupportedLanguagePairException,
                                                                InvalidRequestException,
                                                                ResourceNotFoundException,
                                                                InternalServerException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                TranslateException

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.

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

Parameters:

startTextTranslationJobRequest - A Consumer that will call methods on StartTextTranslationJobRequest.Builder to create a request.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

stopTextTranslationJob

default StopTextTranslationJobResponse stopTextTranslationJob(StopTextTranslationJobRequest stopTextTranslationJobRequest)
                                                       throws ResourceNotFoundException,
                                                              TooManyRequestsException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

stopTextTranslationJob

default StopTextTranslationJobResponse stopTextTranslationJob(Consumer<StopTextTranslationJobRequest.Builder> stopTextTranslationJobRequest)
                                                       throws ResourceNotFoundException,
                                                              TooManyRequestsException,
                                                              InternalServerException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              TranslateException

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.

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

Parameters:

stopTextTranslationJobRequest - A Consumer that will call methods on StopTextTranslationJobRequest.Builder to create a request.

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.

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.

AwsServiceException

See Also:

AWS API Documentation

translateText

default TranslateTextResponse translateText(TranslateTextRequest translateTextRequest)
                                     throws InvalidRequestException,
                                            TextSizeLimitExceededException,
                                            TooManyRequestsException,
                                            UnsupportedLanguagePairException,
                                            DetectedLanguageLowConfidenceException,
                                            ResourceNotFoundException,
                                            InternalServerException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TranslateException

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.

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.

AwsServiceException

See Also:

AWS API Documentation

translateText

default TranslateTextResponse translateText(Consumer<TranslateTextRequest.Builder> translateTextRequest)
                                     throws InvalidRequestException,
                                            TextSizeLimitExceededException,
                                            TooManyRequestsException,
                                            UnsupportedLanguagePairException,
                                            DetectedLanguageLowConfidenceException,
                                            ResourceNotFoundException,
                                            InternalServerException,
                                            ServiceUnavailableException,
                                            AwsServiceException,
                                            SdkClientException,
                                            TranslateException

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

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:

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.

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.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()