aws-sdk-translate 1.17.0 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-translate.rb +7 -4
- data/lib/aws-sdk-translate/client.rb +306 -49
- data/lib/aws-sdk-translate/client_api.rb +159 -0
- data/lib/aws-sdk-translate/errors.rb +47 -9
- data/lib/aws-sdk-translate/resource.rb +1 -0
- data/lib/aws-sdk-translate/types.rb +480 -8
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 55fc0f31c2ae5c5e526f38286ef618beba137263f7e58db7421fb6e837005084
|
4
|
+
data.tar.gz: 2619b91b71fa03b4ae617d30a5061d95dbaa6ffa9f7eb0ede37d59c85b4c1508
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a3a3f00d45fdaffe58fd891d87c736aa79e807e9265da4de8a4251407fac70d24987a2ec5aeda343d18ee4ed3b4c4df17e14ee71d892f5c4b50a8f1fad808fe
|
7
|
+
data.tar.gz: 19243424faabcc7ebd329873e1dd09f3da2789b2601d28a27267d61aa2e9238d862113c31d11ef4e1a454ad630922fb3edc47e36fe519877160ff701bfcacd5c
|
data/lib/aws-sdk-translate.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-translate/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# translate = Aws::Translate::Client.new
|
28
|
+
# resp = translate.delete_terminology(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon Translate
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon Translate are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Translate::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon Translate API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-translate/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Translate
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.22.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:translate)
|
31
31
|
|
32
32
|
module Aws::Translate
|
33
|
+
# An API client for Translate. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Translate::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Translate
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Translate
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Translate
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Translate
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Translate
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Translate
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Translate
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::Translate
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::Translate
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -286,6 +340,55 @@ module Aws::Translate
|
|
286
340
|
req.send_request(options)
|
287
341
|
end
|
288
342
|
|
343
|
+
# Gets the properties associated with an asycnhronous batch translation
|
344
|
+
# job including name, ID, status, source and target languages,
|
345
|
+
# input/output S3 buckets, and so on.
|
346
|
+
#
|
347
|
+
# @option params [required, String] :job_id
|
348
|
+
# The identifier that Amazon Translate generated for the job. The
|
349
|
+
# StartTextTranslationJob operation returns this identifier in its
|
350
|
+
# response.
|
351
|
+
#
|
352
|
+
# @return [Types::DescribeTextTranslationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
353
|
+
#
|
354
|
+
# * {Types::DescribeTextTranslationJobResponse#text_translation_job_properties #text_translation_job_properties} => Types::TextTranslationJobProperties
|
355
|
+
#
|
356
|
+
# @example Request syntax with placeholder values
|
357
|
+
#
|
358
|
+
# resp = client.describe_text_translation_job({
|
359
|
+
# job_id: "JobId", # required
|
360
|
+
# })
|
361
|
+
#
|
362
|
+
# @example Response structure
|
363
|
+
#
|
364
|
+
# resp.text_translation_job_properties.job_id #=> String
|
365
|
+
# resp.text_translation_job_properties.job_name #=> String
|
366
|
+
# resp.text_translation_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
|
367
|
+
# resp.text_translation_job_properties.job_details.translated_documents_count #=> Integer
|
368
|
+
# resp.text_translation_job_properties.job_details.documents_with_errors_count #=> Integer
|
369
|
+
# resp.text_translation_job_properties.job_details.input_documents_count #=> Integer
|
370
|
+
# resp.text_translation_job_properties.source_language_code #=> String
|
371
|
+
# resp.text_translation_job_properties.target_language_codes #=> Array
|
372
|
+
# resp.text_translation_job_properties.target_language_codes[0] #=> String
|
373
|
+
# resp.text_translation_job_properties.terminology_names #=> Array
|
374
|
+
# resp.text_translation_job_properties.terminology_names[0] #=> String
|
375
|
+
# resp.text_translation_job_properties.message #=> String
|
376
|
+
# resp.text_translation_job_properties.submitted_time #=> Time
|
377
|
+
# resp.text_translation_job_properties.end_time #=> Time
|
378
|
+
# resp.text_translation_job_properties.input_data_config.s3_uri #=> String
|
379
|
+
# resp.text_translation_job_properties.input_data_config.content_type #=> String
|
380
|
+
# resp.text_translation_job_properties.output_data_config.s3_uri #=> String
|
381
|
+
# resp.text_translation_job_properties.data_access_role_arn #=> String
|
382
|
+
#
|
383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/DescribeTextTranslationJob AWS API Documentation
|
384
|
+
#
|
385
|
+
# @overload describe_text_translation_job(params = {})
|
386
|
+
# @param [Hash] params ({})
|
387
|
+
def describe_text_translation_job(params = {}, options = {})
|
388
|
+
req = build_request(:describe_text_translation_job, params)
|
389
|
+
req.send_request(options)
|
390
|
+
end
|
391
|
+
|
289
392
|
# Retrieves a custom terminology.
|
290
393
|
#
|
291
394
|
# @option params [required, String] :name
|
@@ -421,6 +524,8 @@ module Aws::Translate
|
|
421
524
|
# * {Types::ListTerminologiesResponse#terminology_properties_list #terminology_properties_list} => Array<Types::TerminologyProperties>
|
422
525
|
# * {Types::ListTerminologiesResponse#next_token #next_token} => String
|
423
526
|
#
|
527
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
528
|
+
#
|
424
529
|
# @example Request syntax with placeholder values
|
425
530
|
#
|
426
531
|
# resp = client.list_terminologies({
|
@@ -454,62 +559,208 @@ module Aws::Translate
|
|
454
559
|
req.send_request(options)
|
455
560
|
end
|
456
561
|
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
562
|
+
# Gets a list of the batch translation jobs that you have submitted.
|
563
|
+
#
|
564
|
+
# @option params [Types::TextTranslationJobFilter] :filter
|
565
|
+
# The parameters that specify which batch translation jobs to retrieve.
|
566
|
+
# Filters include job name, job status, and submission time. You can
|
567
|
+
# only set one filter at a time.
|
462
568
|
#
|
463
|
-
#
|
569
|
+
# @option params [String] :next_token
|
570
|
+
# The token to request the next page of results.
|
464
571
|
#
|
465
|
-
#
|
572
|
+
# @option params [Integer] :max_results
|
573
|
+
# The maximum number of results to return in each page. The default
|
574
|
+
# value is 100.
|
466
575
|
#
|
467
|
-
#
|
576
|
+
# @return [Types::ListTextTranslationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
468
577
|
#
|
469
|
-
#
|
578
|
+
# * {Types::ListTextTranslationJobsResponse#text_translation_job_properties_list #text_translation_job_properties_list} => Array<Types::TextTranslationJobProperties>
|
579
|
+
# * {Types::ListTextTranslationJobsResponse#next_token #next_token} => String
|
470
580
|
#
|
471
|
-
#
|
581
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
472
582
|
#
|
473
|
-
#
|
583
|
+
# @example Request syntax with placeholder values
|
474
584
|
#
|
475
|
-
#
|
585
|
+
# resp = client.list_text_translation_jobs({
|
586
|
+
# filter: {
|
587
|
+
# job_name: "JobName",
|
588
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERROR, FAILED, STOP_REQUESTED, STOPPED
|
589
|
+
# submitted_before_time: Time.now,
|
590
|
+
# submitted_after_time: Time.now,
|
591
|
+
# },
|
592
|
+
# next_token: "NextToken",
|
593
|
+
# max_results: 1,
|
594
|
+
# })
|
476
595
|
#
|
477
|
-
#
|
596
|
+
# @example Response structure
|
478
597
|
#
|
479
|
-
#
|
598
|
+
# resp.text_translation_job_properties_list #=> Array
|
599
|
+
# resp.text_translation_job_properties_list[0].job_id #=> String
|
600
|
+
# resp.text_translation_job_properties_list[0].job_name #=> String
|
601
|
+
# resp.text_translation_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
|
602
|
+
# resp.text_translation_job_properties_list[0].job_details.translated_documents_count #=> Integer
|
603
|
+
# resp.text_translation_job_properties_list[0].job_details.documents_with_errors_count #=> Integer
|
604
|
+
# resp.text_translation_job_properties_list[0].job_details.input_documents_count #=> Integer
|
605
|
+
# resp.text_translation_job_properties_list[0].source_language_code #=> String
|
606
|
+
# resp.text_translation_job_properties_list[0].target_language_codes #=> Array
|
607
|
+
# resp.text_translation_job_properties_list[0].target_language_codes[0] #=> String
|
608
|
+
# resp.text_translation_job_properties_list[0].terminology_names #=> Array
|
609
|
+
# resp.text_translation_job_properties_list[0].terminology_names[0] #=> String
|
610
|
+
# resp.text_translation_job_properties_list[0].message #=> String
|
611
|
+
# resp.text_translation_job_properties_list[0].submitted_time #=> Time
|
612
|
+
# resp.text_translation_job_properties_list[0].end_time #=> Time
|
613
|
+
# resp.text_translation_job_properties_list[0].input_data_config.s3_uri #=> String
|
614
|
+
# resp.text_translation_job_properties_list[0].input_data_config.content_type #=> String
|
615
|
+
# resp.text_translation_job_properties_list[0].output_data_config.s3_uri #=> String
|
616
|
+
# resp.text_translation_job_properties_list[0].data_access_role_arn #=> String
|
617
|
+
# resp.next_token #=> String
|
480
618
|
#
|
481
|
-
#
|
619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/ListTextTranslationJobs AWS API Documentation
|
482
620
|
#
|
483
|
-
#
|
621
|
+
# @overload list_text_translation_jobs(params = {})
|
622
|
+
# @param [Hash] params ({})
|
623
|
+
def list_text_translation_jobs(params = {}, options = {})
|
624
|
+
req = build_request(:list_text_translation_jobs, params)
|
625
|
+
req.send_request(options)
|
626
|
+
end
|
627
|
+
|
628
|
+
# Starts an asynchronous batch translation job. Batch translation jobs
|
629
|
+
# can be used to translate large volumes of text across multiple
|
630
|
+
# documents at once. For more information, see async.
|
484
631
|
#
|
485
|
-
#
|
632
|
+
# Batch translation jobs can be described with the
|
633
|
+
# DescribeTextTranslationJob operation, listed with the
|
634
|
+
# ListTextTranslationJobs operation, and stopped with the
|
635
|
+
# StopTextTranslationJob operation.
|
486
636
|
#
|
487
|
-
#
|
637
|
+
# <note markdown="1"> Amazon Translate does not support batch translation of multiple source
|
638
|
+
# languages at once.
|
488
639
|
#
|
489
|
-
#
|
640
|
+
# </note>
|
490
641
|
#
|
491
|
-
#
|
642
|
+
# @option params [String] :job_name
|
643
|
+
# The name of the batch translation job to be performed.
|
492
644
|
#
|
493
|
-
#
|
645
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
646
|
+
# Specifies the format and S3 location of the input documents for the
|
647
|
+
# translation job.
|
494
648
|
#
|
495
|
-
#
|
649
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
650
|
+
# Specifies the S3 folder to which your job output will be saved.
|
496
651
|
#
|
497
|
-
#
|
652
|
+
# @option params [required, String] :data_access_role_arn
|
653
|
+
# The Amazon Resource Name (ARN) of an AWS Identity Access and
|
654
|
+
# Management (IAM) role that grants Amazon Translate read access to your
|
655
|
+
# input data. For more nformation, see identity-and-access-management.
|
498
656
|
#
|
499
|
-
#
|
657
|
+
# @option params [required, String] :source_language_code
|
658
|
+
# The language code of the input language. For a list of language codes,
|
659
|
+
# see what-is-languages.
|
500
660
|
#
|
501
|
-
#
|
661
|
+
# Amazon Translate does not automatically detect a source language
|
662
|
+
# during batch translation jobs.
|
502
663
|
#
|
503
|
-
#
|
664
|
+
# @option params [required, Array<String>] :target_language_codes
|
665
|
+
# The language code of the output language.
|
504
666
|
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
# determine the source language.
|
667
|
+
# @option params [Array<String>] :terminology_names
|
668
|
+
# The name of the terminology to use in the batch translation job. For a
|
669
|
+
# list of available terminologies, use the ListTerminologies operation.
|
509
670
|
#
|
671
|
+
# @option params [required, String] :client_token
|
672
|
+
# The client token of the EC2 instance calling the request. This token
|
673
|
+
# is auto-generated when using the Amazon Translate SDK. Otherwise, use
|
674
|
+
# the
|
675
|
+
# [DescribeInstances](docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html)
|
676
|
+
# EC2 operation to retreive an instance's client token. For more
|
677
|
+
# information, see [Client
|
678
|
+
# Tokens](docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html#client-tokens)
|
679
|
+
# in the EC2 User Guide.
|
510
680
|
#
|
681
|
+
# **A suitable default value is auto-generated.** You should normally
|
682
|
+
# not need to pass this option.**
|
511
683
|
#
|
512
|
-
# [
|
684
|
+
# @return [Types::StartTextTranslationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
685
|
+
#
|
686
|
+
# * {Types::StartTextTranslationJobResponse#job_id #job_id} => String
|
687
|
+
# * {Types::StartTextTranslationJobResponse#job_status #job_status} => String
|
688
|
+
#
|
689
|
+
# @example Request syntax with placeholder values
|
690
|
+
#
|
691
|
+
# resp = client.start_text_translation_job({
|
692
|
+
# job_name: "JobName",
|
693
|
+
# input_data_config: { # required
|
694
|
+
# s3_uri: "S3Uri", # required
|
695
|
+
# content_type: "ContentType", # required
|
696
|
+
# },
|
697
|
+
# output_data_config: { # required
|
698
|
+
# s3_uri: "S3Uri", # required
|
699
|
+
# },
|
700
|
+
# data_access_role_arn: "IamRoleArn", # required
|
701
|
+
# source_language_code: "LanguageCodeString", # required
|
702
|
+
# target_language_codes: ["LanguageCodeString"], # required
|
703
|
+
# terminology_names: ["ResourceName"],
|
704
|
+
# client_token: "ClientTokenString", # required
|
705
|
+
# })
|
706
|
+
#
|
707
|
+
# @example Response structure
|
708
|
+
#
|
709
|
+
# resp.job_id #=> String
|
710
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
|
711
|
+
#
|
712
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/StartTextTranslationJob AWS API Documentation
|
713
|
+
#
|
714
|
+
# @overload start_text_translation_job(params = {})
|
715
|
+
# @param [Hash] params ({})
|
716
|
+
def start_text_translation_job(params = {}, options = {})
|
717
|
+
req = build_request(:start_text_translation_job, params)
|
718
|
+
req.send_request(options)
|
719
|
+
end
|
720
|
+
|
721
|
+
# Stops an asynchronous batch translation job that is in progress.
|
722
|
+
#
|
723
|
+
# If the job's state is `IN_PROGRESS`, the job will be marked for
|
724
|
+
# termination and put into the `STOP_REQUESTED` state. If the job
|
725
|
+
# completes before it can be stopped, it is put into the `COMPLETED`
|
726
|
+
# state. Otherwise, the job is put into the `STOPPED` state.
|
727
|
+
#
|
728
|
+
# Asynchronous batch translation jobs are started with the
|
729
|
+
# StartTextTranslationJob operation. You can use the
|
730
|
+
# DescribeTextTranslationJob or ListTextTranslationJobs operations to
|
731
|
+
# get a batch translation job's `JobId`.
|
732
|
+
#
|
733
|
+
# @option params [required, String] :job_id
|
734
|
+
# The job ID of the job to be stopped.
|
735
|
+
#
|
736
|
+
# @return [Types::StopTextTranslationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
737
|
+
#
|
738
|
+
# * {Types::StopTextTranslationJobResponse#job_id #job_id} => String
|
739
|
+
# * {Types::StopTextTranslationJobResponse#job_status #job_status} => String
|
740
|
+
#
|
741
|
+
# @example Request syntax with placeholder values
|
742
|
+
#
|
743
|
+
# resp = client.stop_text_translation_job({
|
744
|
+
# job_id: "JobId", # required
|
745
|
+
# })
|
746
|
+
#
|
747
|
+
# @example Response structure
|
748
|
+
#
|
749
|
+
# resp.job_id #=> String
|
750
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERROR", "FAILED", "STOP_REQUESTED", "STOPPED"
|
751
|
+
#
|
752
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/translate-2017-07-01/StopTextTranslationJob AWS API Documentation
|
753
|
+
#
|
754
|
+
# @overload stop_text_translation_job(params = {})
|
755
|
+
# @param [Hash] params ({})
|
756
|
+
def stop_text_translation_job(params = {}, options = {})
|
757
|
+
req = build_request(:stop_text_translation_job, params)
|
758
|
+
req.send_request(options)
|
759
|
+
end
|
760
|
+
|
761
|
+
# Translates input text from the source language to the target language.
|
762
|
+
# For a list of available languages and language codes, see
|
763
|
+
# what-is-languages.
|
513
764
|
#
|
514
765
|
# @option params [required, String] :text
|
515
766
|
# The text to translate. The text string can be a maximum of 5,000 bytes
|
@@ -517,18 +768,24 @@ module Aws::Translate
|
|
517
768
|
# characters.
|
518
769
|
#
|
519
770
|
# @option params [Array<String>] :terminology_names
|
520
|
-
# The
|
521
|
-
# request.
|
771
|
+
# The name of the terminology list file to be used in the TranslateText
|
772
|
+
# request. You can use 1 terminology list at most in a `TranslateText`
|
773
|
+
# request. Terminology lists can contain a maximum of 256 terms.
|
522
774
|
#
|
523
775
|
# @option params [required, String] :source_language_code
|
524
776
|
# The language code for the language of the source text. The language
|
525
|
-
# must be a language supported by Amazon Translate.
|
777
|
+
# must be a language supported by Amazon Translate. For a list of
|
778
|
+
# language codes, see what-is-languages.
|
526
779
|
#
|
527
780
|
# To have Amazon Translate determine the source language of your text,
|
528
781
|
# you can specify `auto` in the `SourceLanguageCode` field. If you
|
529
|
-
# specify `auto`, Amazon Translate will call Amazon Comprehend to
|
782
|
+
# specify `auto`, Amazon Translate will call [Amazon Comprehend][1] to
|
530
783
|
# determine the source language.
|
531
784
|
#
|
785
|
+
#
|
786
|
+
#
|
787
|
+
# [1]: https://docs.aws.amazon.com/comprehend/latest/dg/comprehend-general.html
|
788
|
+
#
|
532
789
|
# @option params [required, String] :target_language_code
|
533
790
|
# The language code requested for the language of the target text. The
|
534
791
|
# language must be a language supported by Amazon Translate.
|
@@ -582,7 +839,7 @@ module Aws::Translate
|
|
582
839
|
params: params,
|
583
840
|
config: config)
|
584
841
|
context[:gem_name] = 'aws-sdk-translate'
|
585
|
-
context[:gem_version] = '1.
|
842
|
+
context[:gem_version] = '1.22.0'
|
586
843
|
Seahorse::Client::Request.new(handlers, context)
|
587
844
|
end
|
588
845
|
|