aws-sdk-textract 1.11.0 → 1.16.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 1bf20998fc774ea09529b86887c30c705053ae44
4
- data.tar.gz: 522589b5ec0f6a46466ee1079bd928e375a43b12
2
+ SHA256:
3
+ metadata.gz: cdfa2b5cc2d97eafde10b5415facb69d41216071f301544f7f4f012862aaf20e
4
+ data.tar.gz: a29f892ed90962cdebb8d67789173d94db952a782a6ea78174328a02ca86f789
5
5
  SHA512:
6
- metadata.gz: 07bc5768da20330e5a6631d20e9b3946b74d6602e948a1147624c56b36a41f68f9d8c15d8fea9cf5d85ef3c764fb562c51be5fabe2e4c291e2ddd171671b4355
7
- data.tar.gz: 5c293d2c8633f731e1ea863bcab6b11bcb358a81e64472d470802f0ee22a8199fbfd9351a4486cc9e24c554433a5d6adbcda769aace7c07b278e5554d291bade
6
+ metadata.gz: 79e17d70bdfed96a06e0367209bce4ce86cc4f5babf56c73644c510714949668d8fa0390cf23d0e52defca0f648ce3a259fb714fba24aa7a5d31530e979790e7
7
+ data.tar.gz: 9f5a3e1ee13b53acf38a57f278f69dc0d6206f97e0544e2568938c8a3541062bf6b6c4862fbdebaf088ddfb668eadcf78d2ecfcc825cc13f6f9dfc9dbe0dd7eb
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-textract/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # textract = Aws::Textract::Client.new
28
+ # resp = textract.analyze_document(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Textract all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Textract 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::Textract::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Textract API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-textract/customizations'
42
45
  # @service
43
46
  module Aws::Textract
44
47
 
45
- GEM_VERSION = '1.11.0'
48
+ GEM_VERSION = '1.16.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:textract)
31
32
 
32
33
  module Aws::Textract
34
+ # An API client for Textract. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::Textract::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::Textract
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::Textract
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::Textract
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::Textract
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::Textract
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::Textract
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::Textract
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
175
210
  #
176
211
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::Textract
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
187
226
  #
188
227
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::Textract
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # 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}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::Textract
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -268,27 +324,30 @@ module Aws::Textract
268
324
  #
269
325
  # The types of information returned are as follows:
270
326
  #
271
- # * Words and lines that are related to nearby lines and words. The
272
- # related information is returned in two Block objects each of type
273
- # `KEY_VALUE_SET`\: a KEY Block object and a VALUE Block object. For
274
- # example, *Name: Ana Silva Carolina* contains a key and value.
275
- # *Name:* is the key. *Ana Silva Carolina* is the value.
327
+ # * Form data (key-value pairs). The related information is returned in
328
+ # two Block objects, each of type `KEY_VALUE_SET`\: a KEY `Block`
329
+ # object and a VALUE `Block` object. For example, *Name: Ana Silva
330
+ # Carolina* contains a key and value. *Name:* is the key. *Ana Silva
331
+ # Carolina* is the value.
276
332
  #
277
- # * Table and table cell data. A TABLE Block object contains information
278
- # about a detected table. A CELL Block object is returned for each
279
- # cell in a table.
333
+ # * Table and table cell data. A TABLE `Block` object contains
334
+ # information about a detected table. A CELL `Block` object is
335
+ # returned for each cell in a table.
280
336
  #
281
- # * Selectable elements such as checkboxes and radio buttons. A
282
- # SELECTION\_ELEMENT Block object contains information about a
283
- # selectable element.
337
+ # * Lines and words of text. A LINE `Block` object contains one or more
338
+ # WORD `Block` objects. All lines and words that are detected in the
339
+ # document are returned (including text that doesn't have a
340
+ # relationship with the value of `FeatureTypes`).
284
341
  #
285
- # * Lines and words of text. A LINE Block object contains one or more
286
- # WORD Block objects.
342
+ # Selection elements such as check boxes and option buttons (radio
343
+ # buttons) can be detected in form data and in tables. A
344
+ # SELECTION\_ELEMENT `Block` object contains information about a
345
+ # selection element, including the selection status.
287
346
  #
288
347
  # You can choose which type of analysis to perform by specifying the
289
348
  # `FeatureTypes` list.
290
349
  #
291
- # The output is returned in a list of `BLOCK` objects.
350
+ # The output is returned in a list of `Block` objects.
292
351
  #
293
352
  # `AnalyzeDocument` is a synchronous operation. To analyze documents
294
353
  # asynchronously, use StartDocumentAnalysis.
@@ -302,22 +361,30 @@ module Aws::Textract
302
361
  # @option params [required, Types::Document] :document
303
362
  # The input document as base64-encoded bytes or an Amazon S3 object. If
304
363
  # you use the AWS CLI to call Amazon Textract operations, you can't
305
- # pass image bytes. The document must be an image in JPG or PNG format.
364
+ # pass image bytes. The document must be an image in JPEG or PNG format.
306
365
  #
307
- # If you are using an AWS SDK to call Amazon Textract, you might not
308
- # need to base64-encode image bytes passed using the `Bytes` field.
366
+ # If you're using an AWS SDK to call Amazon Textract, you might not
367
+ # need to base64-encode image bytes that are passed using the `Bytes`
368
+ # field.
309
369
  #
310
370
  # @option params [required, Array<String>] :feature_types
311
371
  # A list of the types of analysis to perform. Add TABLES to the list to
312
- # return information about the tables detected in the input document.
313
- # Add FORMS to return detected fields and the associated text. To
314
- # perform both types of analysis, add TABLES and FORMS to
315
- # `FeatureTypes`.
372
+ # return information about the tables that are detected in the input
373
+ # document. Add FORMS to return detected form data. To perform both
374
+ # types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
375
+ # and words detected in the document are included in the response
376
+ # (including text that isn't related to the value of `FeatureTypes`).
377
+ #
378
+ # @option params [Types::HumanLoopConfig] :human_loop_config
379
+ # Sets the configuration for the human in the loop workflow for
380
+ # analyzing documents.
316
381
  #
317
382
  # @return [Types::AnalyzeDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
318
383
  #
319
384
  # * {Types::AnalyzeDocumentResponse#document_metadata #document_metadata} => Types::DocumentMetadata
320
385
  # * {Types::AnalyzeDocumentResponse#blocks #blocks} => Array&lt;Types::Block&gt;
386
+ # * {Types::AnalyzeDocumentResponse#human_loop_activation_output #human_loop_activation_output} => Types::HumanLoopActivationOutput
387
+ # * {Types::AnalyzeDocumentResponse#analyze_document_model_version #analyze_document_model_version} => String
321
388
  #
322
389
  # @example Request syntax with placeholder values
323
390
  #
@@ -331,6 +398,13 @@ module Aws::Textract
331
398
  # },
332
399
  # },
333
400
  # feature_types: ["TABLES"], # required, accepts TABLES, FORMS
401
+ # human_loop_config: {
402
+ # human_loop_name: "HumanLoopName", # required
403
+ # flow_definition_arn: "FlowDefinitionArn", # required
404
+ # data_attributes: {
405
+ # content_classifiers: ["FreeOfPersonallyIdentifiableInformation"], # accepts FreeOfPersonallyIdentifiableInformation, FreeOfAdultContent
406
+ # },
407
+ # },
334
408
  # })
335
409
  #
336
410
  # @example Response structure
@@ -360,6 +434,11 @@ module Aws::Textract
360
434
  # resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
361
435
  # resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
362
436
  # resp.blocks[0].page #=> Integer
437
+ # resp.human_loop_activation_output.human_loop_arn #=> String
438
+ # resp.human_loop_activation_output.human_loop_activation_reasons #=> Array
439
+ # resp.human_loop_activation_output.human_loop_activation_reasons[0] #=> String
440
+ # resp.human_loop_activation_output.human_loop_activation_conditions_evaluation_results #=> String
441
+ # resp.analyze_document_model_version #=> String
363
442
  #
364
443
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/AnalyzeDocument AWS API Documentation
365
444
  #
@@ -372,7 +451,7 @@ module Aws::Textract
372
451
 
373
452
  # Detects text in the input document. Amazon Textract can detect lines
374
453
  # of text and the words that make up a line of text. The input document
375
- # must be an image in JPG or PNG format. `DetectDocumentText` returns
454
+ # must be an image in JPEG or PNG format. `DetectDocumentText` returns
376
455
  # the detected text in an array of Block objects.
377
456
  #
378
457
  # Each document page has as an associated `Block` of type PAGE. Each
@@ -393,15 +472,17 @@ module Aws::Textract
393
472
  # @option params [required, Types::Document] :document
394
473
  # The input document as base64-encoded bytes or an Amazon S3 object. If
395
474
  # you use the AWS CLI to call Amazon Textract operations, you can't
396
- # pass image bytes. The document must be an image in JPG or PNG format.
475
+ # pass image bytes. The document must be an image in JPEG or PNG format.
397
476
  #
398
- # If you are using an AWS SDK to call Amazon Textract, you might not
399
- # need to base64-encode image bytes passed using the `Bytes` field.
477
+ # If you're using an AWS SDK to call Amazon Textract, you might not
478
+ # need to base64-encode image bytes that are passed using the `Bytes`
479
+ # field.
400
480
  #
401
481
  # @return [Types::DetectDocumentTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
402
482
  #
403
483
  # * {Types::DetectDocumentTextResponse#document_metadata #document_metadata} => Types::DocumentMetadata
404
484
  # * {Types::DetectDocumentTextResponse#blocks #blocks} => Array&lt;Types::Block&gt;
485
+ # * {Types::DetectDocumentTextResponse#detect_document_text_model_version #detect_document_text_model_version} => String
405
486
  #
406
487
  # @example Request syntax with placeholder values
407
488
  #
@@ -443,6 +524,7 @@ module Aws::Textract
443
524
  # resp.blocks[0].entity_types[0] #=> String, one of "KEY", "VALUE"
444
525
  # resp.blocks[0].selection_status #=> String, one of "SELECTED", "NOT_SELECTED"
445
526
  # resp.blocks[0].page #=> Integer
527
+ # resp.detect_document_text_model_version #=> String
446
528
  #
447
529
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectDocumentText AWS API Documentation
448
530
  #
@@ -469,30 +551,34 @@ module Aws::Textract
469
551
  # `GetDocumentAnalysis` returns an array of Block objects. The following
470
552
  # types of information are returned:
471
553
  #
472
- # * Words and lines that are related to nearby lines and words. The
473
- # related information is returned in two Block objects each of type
474
- # `KEY_VALUE_SET`\: a KEY Block object and a VALUE Block object. For
475
- # example, *Name: Ana Silva Carolina* contains a key and value.
476
- # *Name:* is the key. *Ana Silva Carolina* is the value.
554
+ # * Form data (key-value pairs). The related information is returned in
555
+ # two Block objects, each of type `KEY_VALUE_SET`\: a KEY `Block`
556
+ # object and a VALUE `Block` object. For example, *Name: Ana Silva
557
+ # Carolina* contains a key and value. *Name:* is the key. *Ana Silva
558
+ # Carolina* is the value.
477
559
  #
478
- # * Table and table cell data. A TABLE Block object contains information
479
- # about a detected table. A CELL Block object is returned for each
480
- # cell in a table.
560
+ # * Table and table cell data. A TABLE `Block` object contains
561
+ # information about a detected table. A CELL `Block` object is
562
+ # returned for each cell in a table.
481
563
  #
482
- # * Selectable elements such as checkboxes and radio buttons. A
483
- # SELECTION\_ELEMENT Block object contains information about a
484
- # selectable element.
564
+ # * Lines and words of text. A LINE `Block` object contains one or more
565
+ # WORD `Block` objects. All lines and words that are detected in the
566
+ # document are returned (including text that doesn't have a
567
+ # relationship with the value of the `StartDocumentAnalysis`
568
+ # `FeatureTypes` input parameter).
485
569
  #
486
- # * Lines and words of text. A LINE Block object contains one or more
487
- # WORD Block objects.
570
+ # Selection elements such as check boxes and option buttons (radio
571
+ # buttons) can be detected in form data and in tables. A
572
+ # SELECTION\_ELEMENT `Block` object contains information about a
573
+ # selection element, including the selection status.
488
574
  #
489
- # Use the `MaxResults` parameter to limit the number of blocks returned.
490
- # If there are more results than specified in `MaxResults`, the value of
491
- # `NextToken` in the operation response contains a pagination token for
492
- # getting the next set of results. To get the next page of results, call
493
- # `GetDocumentAnalysis`, and populate the `NextToken` request parameter
494
- # with the token value that's returned from the previous call to
495
- # `GetDocumentAnalysis`.
575
+ # Use the `MaxResults` parameter to limit the number of blocks that are
576
+ # returned. If there are more results than specified in `MaxResults`,
577
+ # the value of `NextToken` in the operation response contains a
578
+ # pagination token for getting the next set of results. To get the next
579
+ # page of results, call `GetDocumentAnalysis`, and populate the
580
+ # `NextToken` request parameter with the token value that's returned
581
+ # from the previous call to `GetDocumentAnalysis`.
496
582
  #
497
583
  # For more information, see [Document Text Analysis][1].
498
584
  #
@@ -502,7 +588,8 @@ module Aws::Textract
502
588
  #
503
589
  # @option params [required, String] :job_id
504
590
  # A unique identifier for the text-detection job. The `JobId` is
505
- # returned from `StartDocumentAnalysis`.
591
+ # returned from `StartDocumentAnalysis`. A `JobId` value is only valid
592
+ # for 7 days.
506
593
  #
507
594
  # @option params [Integer] :max_results
508
595
  # The maximum number of results to return per paginated call. The
@@ -524,6 +611,7 @@ module Aws::Textract
524
611
  # * {Types::GetDocumentAnalysisResponse#blocks #blocks} => Array&lt;Types::Block&gt;
525
612
  # * {Types::GetDocumentAnalysisResponse#warnings #warnings} => Array&lt;Types::Warning&gt;
526
613
  # * {Types::GetDocumentAnalysisResponse#status_message #status_message} => String
614
+ # * {Types::GetDocumentAnalysisResponse#analyze_document_model_version #analyze_document_model_version} => String
527
615
  #
528
616
  # @example Request syntax with placeholder values
529
617
  #
@@ -567,6 +655,7 @@ module Aws::Textract
567
655
  # resp.warnings[0].pages #=> Array
568
656
  # resp.warnings[0].pages[0] #=> Integer
569
657
  # resp.status_message #=> String
658
+ # resp.analyze_document_model_version #=> String
570
659
  #
571
660
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentAnalysis AWS API Documentation
572
661
  #
@@ -616,7 +705,8 @@ module Aws::Textract
616
705
  #
617
706
  # @option params [required, String] :job_id
618
707
  # A unique identifier for the text detection job. The `JobId` is
619
- # returned from `StartDocumentTextDetection`.
708
+ # returned from `StartDocumentTextDetection`. A `JobId` value is only
709
+ # valid for 7 days.
620
710
  #
621
711
  # @option params [Integer] :max_results
622
712
  # The maximum number of results to return per paginated call. The
@@ -638,6 +728,7 @@ module Aws::Textract
638
728
  # * {Types::GetDocumentTextDetectionResponse#blocks #blocks} => Array&lt;Types::Block&gt;
639
729
  # * {Types::GetDocumentTextDetectionResponse#warnings #warnings} => Array&lt;Types::Warning&gt;
640
730
  # * {Types::GetDocumentTextDetectionResponse#status_message #status_message} => String
731
+ # * {Types::GetDocumentTextDetectionResponse#detect_document_text_model_version #detect_document_text_model_version} => String
641
732
  #
642
733
  # @example Request syntax with placeholder values
643
734
  #
@@ -681,6 +772,7 @@ module Aws::Textract
681
772
  # resp.warnings[0].pages #=> Array
682
773
  # resp.warnings[0].pages[0] #=> Integer
683
774
  # resp.status_message #=> String
775
+ # resp.detect_document_text_model_version #=> String
684
776
  #
685
777
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetDocumentTextDetection AWS API Documentation
686
778
  #
@@ -691,14 +783,14 @@ module Aws::Textract
691
783
  req.send_request(options)
692
784
  end
693
785
 
694
- # Starts asynchronous analysis of an input document for relationships
695
- # between detected items such as key and value pairs, tables, and
696
- # selection elements.
786
+ # Starts the asynchronous analysis of an input document for
787
+ # relationships between detected items such as key-value pairs, tables,
788
+ # and selection elements.
697
789
  #
698
- # `StartDocumentAnalysis` can analyze text in documents that are in JPG,
699
- # PNG, and PDF format. The documents are stored in an Amazon S3 bucket.
700
- # Use DocumentLocation to specify the bucket name and file name of the
701
- # document.
790
+ # `StartDocumentAnalysis` can analyze text in documents that are in
791
+ # JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
792
+ # bucket. Use DocumentLocation to specify the bucket name and file name
793
+ # of the document.
702
794
  #
703
795
  # `StartDocumentAnalysis` returns a job identifier (`JobId`) that you
704
796
  # use to get the results of the operation. When text analysis is
@@ -722,22 +814,27 @@ module Aws::Textract
722
814
  # @option params [required, Array<String>] :feature_types
723
815
  # A list of the types of analysis to perform. Add TABLES to the list to
724
816
  # return information about the tables that are detected in the input
725
- # document. Add FORMS to return detected fields and the associated text.
726
- # To perform both types of analysis, add TABLES and FORMS to
727
- # `FeatureTypes`. All selectable elements (`SELECTION_ELEMENT`) that are
728
- # detected are returned, whatever the value of `FeatureTypes`.
817
+ # document. Add FORMS to return detected form data. To perform both
818
+ # types of analysis, add TABLES and FORMS to `FeatureTypes`. All lines
819
+ # and words detected in the document are included in the response
820
+ # (including text that isn't related to the value of `FeatureTypes`).
729
821
  #
730
822
  # @option params [String] :client_request_token
731
823
  # The idempotent token that you use to identify the start request. If
732
824
  # you use the same token with multiple `StartDocumentAnalysis` requests,
733
825
  # the same `JobId` is returned. Use `ClientRequestToken` to prevent the
734
- # same job from being accidentally started more than once.
826
+ # same job from being accidentally started more than once. For more
827
+ # information, see [Calling Amazon Textract Asynchronous Operations][1].
828
+ #
829
+ #
830
+ #
831
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/api-async.html
735
832
  #
736
833
  # @option params [String] :job_tag
737
- # An identifier you specify that's included in the completion
738
- # notification that's published to the Amazon SNS topic. For example,
739
- # you can use `JobTag` to identify the type of document, such as a tax
740
- # form or a receipt, that the completion notification corresponds to.
834
+ # An identifier that you specify that's included in the completion
835
+ # notification published to the Amazon SNS topic. For example, you can
836
+ # use `JobTag` to identify the type of document that the completion
837
+ # notification corresponds to (such as a tax form or a receipt).
741
838
  #
742
839
  # @option params [Types::NotificationChannel] :notification_channel
743
840
  # The Amazon SNS topic ARN that you want Amazon Textract to publish the
@@ -784,7 +881,7 @@ module Aws::Textract
784
881
  # text.
785
882
  #
786
883
  # `StartDocumentTextDetection` can analyze text in documents that are in
787
- # JPG, PNG, and PDF format. The documents are stored in an Amazon S3
884
+ # JPEG, PNG, and PDF format. The documents are stored in an Amazon S3
788
885
  # bucket. Use DocumentLocation to specify the bucket name and file name
789
886
  # of the document.
790
887
  #
@@ -812,12 +909,18 @@ module Aws::Textract
812
909
  # you use the same token with multiple `StartDocumentTextDetection`
813
910
  # requests, the same `JobId` is returned. Use `ClientRequestToken` to
814
911
  # prevent the same job from being accidentally started more than once.
912
+ # For more information, see [Calling Amazon Textract Asynchronous
913
+ # Operations][1].
914
+ #
915
+ #
916
+ #
917
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/api-async.html
815
918
  #
816
919
  # @option params [String] :job_tag
817
- # An identifier you specify that's included in the completion
818
- # notification that's published to the Amazon SNS topic. For example,
819
- # you can use `JobTag` to identify the type of document, such as a tax
820
- # form or a receipt, that the completion notification corresponds to.
920
+ # An identifier that you specify that's included in the completion
921
+ # notification published to the Amazon SNS topic. For example, you can
922
+ # use `JobTag` to identify the type of document that the completion
923
+ # notification corresponds to (such as a tax form or a receipt).
821
924
  #
822
925
  # @option params [Types::NotificationChannel] :notification_channel
823
926
  # The Amazon SNS topic ARN that you want Amazon Textract to publish the
@@ -871,7 +974,7 @@ module Aws::Textract
871
974
  params: params,
872
975
  config: config)
873
976
  context[:gem_name] = 'aws-sdk-textract'
874
- context[:gem_version] = '1.11.0'
977
+ context[:gem_version] = '1.16.1'
875
978
  Seahorse::Client::Request.new(handlers, context)
876
979
  end
877
980