forked from aws-amplify/aws-sdk-android
-
Notifications
You must be signed in to change notification settings - Fork 2
/
AmazonTranslate.java
521 lines (499 loc) · 24 KB
/
AmazonTranslate.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
/*
* Copyright 2010-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.translate;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.translate.model.*;
/**
* Interface for accessing Amazon Translate
* <p>
* Provides translation between one source language and another of the same set
* of languages.
* </p>
**/
public interface AmazonTranslate {
/**
* 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.
* <p>
* 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
* {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* 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: <a
* href=
* "http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912"
* > http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912</a>
* <p>
* <b>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.</b>
*
* @param 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.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonTranslate#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.
* <p>
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
* <p>
* <b>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.</b>
*
* @param region The region this client will communicate with. See
* {@link 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
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
* <p>
* Creates a parallel data resource in Amazon Translate by importing an
* input file from Amazon S3. Parallel data files contain examples that show
* how you want segments of text to be translated. By adding parallel data,
* you can influence the style, tone, and word choice in your translation
* output.
* </p>
*
* @param createParallelDataRequest
* @return createParallelDataResult The response from the CreateParallelData
* service method, as returned by Amazon Translate.
* @throws InvalidParameterValueException
* @throws InvalidRequestException
* @throws LimitExceededException
* @throws TooManyRequestsException
* @throws ConflictException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
CreateParallelDataResult createParallelData(CreateParallelDataRequest createParallelDataRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Deletes a parallel data resource in Amazon Translate.
* </p>
*
* @param deleteParallelDataRequest
* @return deleteParallelDataResult The response from the DeleteParallelData
* service method, as returned by Amazon Translate.
* @throws ConcurrentModificationException
* @throws ResourceNotFoundException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
DeleteParallelDataResult deleteParallelData(DeleteParallelDataRequest deleteParallelDataRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* A synchronous action that deletes a custom terminology.
* </p>
*
* @param deleteTerminologyRequest
* @throws ResourceNotFoundException
* @throws TooManyRequestsException
* @throws InvalidParameterValueException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
void deleteTerminology(DeleteTerminologyRequest deleteTerminologyRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Gets the properties associated with an asynchronous batch translation job
* including name, ID, status, source and target languages, input/output S3
* buckets, and so on.
* </p>
*
* @param describeTextTranslationJobRequest
* @return describeTextTranslationJobResult The response from the
* DescribeTextTranslationJob service method, as returned by Amazon
* Translate.
* @throws ResourceNotFoundException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
DescribeTextTranslationJobResult describeTextTranslationJob(
DescribeTextTranslationJobRequest describeTextTranslationJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Provides information about a parallel data resource.
* </p>
*
* @param getParallelDataRequest
* @return getParallelDataResult The response from the GetParallelData
* service method, as returned by Amazon Translate.
* @throws ResourceNotFoundException
* @throws InvalidParameterValueException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
GetParallelDataResult getParallelData(GetParallelDataRequest getParallelDataRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Retrieves a custom terminology.
* </p>
*
* @param getTerminologyRequest
* @return getTerminologyResult The response from the GetTerminology service
* method, as returned by Amazon Translate.
* @throws ResourceNotFoundException
* @throws InvalidParameterValueException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
GetTerminologyResult getTerminology(GetTerminologyRequest getTerminologyRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Creates or updates a custom terminology, depending on whether one already
* exists for the given terminology name. Importing a terminology with the
* same name as an existing one will merge the terminologies based on the
* chosen merge strategy. The only supported merge strategy is OVERWRITE,
* where the imported terminology overwrites the existing terminology of the
* same name.
* </p>
* <p>
* If you import a terminology that overwrites an existing one, the new
* terminology takes up to 10 minutes to fully propagate. After that,
* translations have access to the new terminology.
* </p>
*
* @param importTerminologyRequest
* @return importTerminologyResult The response from the ImportTerminology
* service method, as returned by Amazon Translate.
* @throws InvalidParameterValueException
* @throws LimitExceededException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
ImportTerminologyResult importTerminology(ImportTerminologyRequest importTerminologyRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Provides a list of languages (RFC-5646 codes and names) that Amazon
* Translate supports.
* </p>
*
* @param listLanguagesRequest
* @return listLanguagesResult The response from the ListLanguages service
* method, as returned by Amazon Translate.
* @throws InvalidParameterValueException
* @throws TooManyRequestsException
* @throws UnsupportedDisplayLanguageCodeException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
ListLanguagesResult listLanguages(ListLanguagesRequest listLanguagesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Provides a list of your parallel data resources in Amazon Translate.
* </p>
*
* @param listParallelDataRequest
* @return listParallelDataResult The response from the ListParallelData
* service method, as returned by Amazon Translate.
* @throws InvalidParameterValueException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
ListParallelDataResult listParallelData(ListParallelDataRequest listParallelDataRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Provides a list of custom terminologies associated with your account.
* </p>
*
* @param listTerminologiesRequest
* @return listTerminologiesResult The response from the ListTerminologies
* service method, as returned by Amazon Translate.
* @throws InvalidParameterValueException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
ListTerminologiesResult listTerminologies(ListTerminologiesRequest listTerminologiesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Gets a list of the batch translation jobs that you have submitted.
* </p>
*
* @param listTextTranslationJobsRequest
* @return listTextTranslationJobsResult The response from the
* ListTextTranslationJobs service method, as returned by Amazon
* Translate.
* @throws InvalidRequestException
* @throws TooManyRequestsException
* @throws InvalidFilterException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
ListTextTranslationJobsResult listTextTranslationJobs(
ListTextTranslationJobsRequest listTextTranslationJobsRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* 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 <a>async</a>.
* </p>
* <p>
* Batch translation jobs can be described with the
* <a>DescribeTextTranslationJob</a> operation, listed with the
* <a>ListTextTranslationJobs</a> operation, and stopped with the
* <a>StopTextTranslationJob</a> operation.
* </p>
* <note>
* <p>
* Amazon Translate does not support batch translation of multiple source
* languages at once.
* </p>
* </note>
*
* @param startTextTranslationJobRequest
* @return startTextTranslationJobResult The response from the
* StartTextTranslationJob service method, as returned by Amazon
* Translate.
* @throws TooManyRequestsException
* @throws UnsupportedLanguagePairException
* @throws InvalidRequestException
* @throws ResourceNotFoundException
* @throws InvalidParameterValueException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
StartTextTranslationJobResult startTextTranslationJob(
StartTextTranslationJobRequest startTextTranslationJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Stops an asynchronous batch translation job that is in progress.
* </p>
* <p>
* If the job's state is <code>IN_PROGRESS</code>, the job will be marked
* for termination and put into the <code>STOP_REQUESTED</code> state. If
* the job completes before it can be stopped, it is put into the
* <code>COMPLETED</code> state. Otherwise, the job is put into the
* <code>STOPPED</code> state.
* </p>
* <p>
* Asynchronous batch translation jobs are started with the
* <a>StartTextTranslationJob</a> operation. You can use the
* <a>DescribeTextTranslationJob</a> or <a>ListTextTranslationJobs</a>
* operations to get a batch translation job's <code>JobId</code>.
* </p>
*
* @param stopTextTranslationJobRequest
* @return stopTextTranslationJobResult The response from the
* StopTextTranslationJob service method, as returned by Amazon
* Translate.
* @throws ResourceNotFoundException
* @throws TooManyRequestsException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
StopTextTranslationJobResult stopTextTranslationJob(
StopTextTranslationJobRequest stopTextTranslationJobRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Translates input text from the source language to the target language.
* For a list of available languages and language codes, see
* <a>what-is-languages</a>.
* </p>
*
* @param translateTextRequest
* @return translateTextResult The response from the TranslateText service
* method, as returned by Amazon Translate.
* @throws InvalidRequestException
* @throws TextSizeLimitExceededException
* @throws TooManyRequestsException
* @throws UnsupportedLanguagePairException
* @throws DetectedLanguageLowConfidenceException
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws ServiceUnavailableException
* @throws 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.
* @throws 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.
*/
TranslateTextResult translateText(TranslateTextRequest translateTextRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Updates a previously created parallel data resource by importing a new
* input file from Amazon S3.
* </p>
*
* @param updateParallelDataRequest
* @return updateParallelDataResult The response from the UpdateParallelData
* service method, as returned by Amazon Translate.
* @throws ConcurrentModificationException
* @throws InvalidParameterValueException
* @throws InvalidRequestException
* @throws LimitExceededException
* @throws TooManyRequestsException
* @throws ConflictException
* @throws ResourceNotFoundException
* @throws InternalServerException
* @throws 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.
* @throws 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.
*/
UpdateParallelDataResult updateParallelData(UpdateParallelDataRequest updateParallelDataRequest)
throws AmazonClientException, AmazonServiceException;
/**
* 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.
*/
public void shutdown();
/**
* 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.
* <p>
* 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.
*
* @param request The originally executed request.
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}