aws-sdk-textract 1.42.0 → 1.43.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.
@@ -567,6 +567,21 @@ module Aws::Textract
567
567
  include Aws::Structure
568
568
  end
569
569
 
570
+ # A structure that holds information regarding a detected signature on a
571
+ # page.
572
+ #
573
+ # @!attribute [rw] page
574
+ # The page a detected signature was found on.
575
+ # @return [Integer]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DetectedSignature AWS API Documentation
578
+ #
579
+ class DetectedSignature < Struct.new(
580
+ :page)
581
+ SENSITIVE = []
582
+ include Aws::Structure
583
+ end
584
+
570
585
  # The input document, either as bytes or as an S3 object.
571
586
  #
572
587
  # You pass image bytes to an Amazon Textract API operation by using the
@@ -626,8 +641,39 @@ module Aws::Textract
626
641
  include Aws::Structure
627
642
  end
628
643
 
644
+ # Summary information about documents grouped by the same document type.
645
+ #
646
+ # @!attribute [rw] type
647
+ # The type of document that Amazon Textract has detected. See LINK for
648
+ # a list of all types returned by Textract.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] split_documents
652
+ # An array that contains information about the pages of a document,
653
+ # defined by logical boundary.
654
+ # @return [Array<Types::SplitDocument>]
655
+ #
656
+ # @!attribute [rw] detected_signatures
657
+ # A list of the detected signatures found in a document group.
658
+ # @return [Array<Types::DetectedSignature>]
659
+ #
660
+ # @!attribute [rw] undetected_signatures
661
+ # A list of any expected signatures not found in a document group.
662
+ # @return [Array<Types::UndetectedSignature>]
663
+ #
664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/DocumentGroup AWS API Documentation
665
+ #
666
+ class DocumentGroup < Struct.new(
667
+ :type,
668
+ :split_documents,
669
+ :detected_signatures,
670
+ :undetected_signatures)
671
+ SENSITIVE = []
672
+ include Aws::Structure
673
+ end
674
+
629
675
  # The Amazon S3 bucket that contains the document to be processed. It's
630
- # used by asynchronous operations such as StartDocumentTextDetection.
676
+ # used by asynchronous operations.
631
677
  #
632
678
  # The input document can be an image file in JPEG or PNG format. It can
633
679
  # also be a file in PDF format.
@@ -867,6 +913,33 @@ module Aws::Textract
867
913
  include Aws::Structure
868
914
  end
869
915
 
916
+ # Contains information extracted by an analysis operation after using
917
+ # StartLendingAnalysis.
918
+ #
919
+ # @!attribute [rw] lending_document
920
+ # Holds the structured data returned by AnalyzeDocument for lending
921
+ # documents.
922
+ # @return [Types::LendingDocument]
923
+ #
924
+ # @!attribute [rw] expense_document
925
+ # The structure holding all the information returned by AnalyzeExpense
926
+ # @return [Types::ExpenseDocument]
927
+ #
928
+ # @!attribute [rw] identity_document
929
+ # The structure that lists each document processed in an AnalyzeID
930
+ # operation.
931
+ # @return [Types::IdentityDocument]
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/Extraction AWS API Documentation
934
+ #
935
+ class Extraction < Struct.new(
936
+ :lending_document,
937
+ :expense_document,
938
+ :identity_document)
939
+ SENSITIVE = []
940
+ include Aws::Structure
941
+ end
942
+
870
943
  # Information about where the following items are located on a document
871
944
  # page: detected page, text, key-value pairs, tables, table cells, and
872
945
  # selection elements.
@@ -1149,6 +1222,151 @@ module Aws::Textract
1149
1222
  include Aws::Structure
1150
1223
  end
1151
1224
 
1225
+ # @note When making an API call, you may pass GetLendingAnalysisRequest
1226
+ # data as a hash:
1227
+ #
1228
+ # {
1229
+ # job_id: "JobId", # required
1230
+ # max_results: 1,
1231
+ # next_token: "PaginationToken",
1232
+ # }
1233
+ #
1234
+ # @!attribute [rw] job_id
1235
+ # A unique identifier for the lending or text-detection job. The
1236
+ # `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is
1237
+ # only valid for 7 days.
1238
+ # @return [String]
1239
+ #
1240
+ # @!attribute [rw] max_results
1241
+ # The maximum number of results to return per paginated call. The
1242
+ # largest value that you can specify is 30. If you specify a value
1243
+ # greater than 30, a maximum of 30 results is returned. The default
1244
+ # value is 30.
1245
+ # @return [Integer]
1246
+ #
1247
+ # @!attribute [rw] next_token
1248
+ # If the previous response was incomplete, Amazon Textract returns a
1249
+ # pagination token in the response. You can use this pagination token
1250
+ # to retrieve the next set of lending results.
1251
+ # @return [String]
1252
+ #
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysisRequest AWS API Documentation
1254
+ #
1255
+ class GetLendingAnalysisRequest < Struct.new(
1256
+ :job_id,
1257
+ :max_results,
1258
+ :next_token)
1259
+ SENSITIVE = []
1260
+ include Aws::Structure
1261
+ end
1262
+
1263
+ # @!attribute [rw] document_metadata
1264
+ # Information about the input document.
1265
+ # @return [Types::DocumentMetadata]
1266
+ #
1267
+ # @!attribute [rw] job_status
1268
+ # The current status of the lending analysis job.
1269
+ # @return [String]
1270
+ #
1271
+ # @!attribute [rw] next_token
1272
+ # If the response is truncated, Amazon Textract returns this token.
1273
+ # You can use this token in the subsequent request to retrieve the
1274
+ # next set of lending results.
1275
+ # @return [String]
1276
+ #
1277
+ # @!attribute [rw] results
1278
+ # Holds the information returned by one of AmazonTextract's document
1279
+ # analysis operations for the pinstripe.
1280
+ # @return [Array<Types::LendingResult>]
1281
+ #
1282
+ # @!attribute [rw] warnings
1283
+ # A list of warnings that occurred during the lending analysis
1284
+ # operation.
1285
+ # @return [Array<Types::Warning>]
1286
+ #
1287
+ # @!attribute [rw] status_message
1288
+ # Returns if the lending analysis job could not be completed. Contains
1289
+ # explanation for what error occurred.
1290
+ # @return [String]
1291
+ #
1292
+ # @!attribute [rw] analyze_lending_model_version
1293
+ # The current model version of the Analyze Lending API.
1294
+ # @return [String]
1295
+ #
1296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysisResponse AWS API Documentation
1297
+ #
1298
+ class GetLendingAnalysisResponse < Struct.new(
1299
+ :document_metadata,
1300
+ :job_status,
1301
+ :next_token,
1302
+ :results,
1303
+ :warnings,
1304
+ :status_message,
1305
+ :analyze_lending_model_version)
1306
+ SENSITIVE = []
1307
+ include Aws::Structure
1308
+ end
1309
+
1310
+ # @note When making an API call, you may pass GetLendingAnalysisSummaryRequest
1311
+ # data as a hash:
1312
+ #
1313
+ # {
1314
+ # job_id: "JobId", # required
1315
+ # }
1316
+ #
1317
+ # @!attribute [rw] job_id
1318
+ # A unique identifier for the lending or text-detection job. The
1319
+ # `JobId` is returned from StartLendingAnalysis. A `JobId` value is
1320
+ # only valid for 7 days.
1321
+ # @return [String]
1322
+ #
1323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysisSummaryRequest AWS API Documentation
1324
+ #
1325
+ class GetLendingAnalysisSummaryRequest < Struct.new(
1326
+ :job_id)
1327
+ SENSITIVE = []
1328
+ include Aws::Structure
1329
+ end
1330
+
1331
+ # @!attribute [rw] document_metadata
1332
+ # Information about the input document.
1333
+ # @return [Types::DocumentMetadata]
1334
+ #
1335
+ # @!attribute [rw] job_status
1336
+ # The current status of the lending analysis job.
1337
+ # @return [String]
1338
+ #
1339
+ # @!attribute [rw] summary
1340
+ # Contains summary information for documents grouped by type.
1341
+ # @return [Types::LendingSummary]
1342
+ #
1343
+ # @!attribute [rw] warnings
1344
+ # A list of warnings that occurred during the lending analysis
1345
+ # operation.
1346
+ # @return [Array<Types::Warning>]
1347
+ #
1348
+ # @!attribute [rw] status_message
1349
+ # Returns if the lending analysis could not be completed. Contains
1350
+ # explanation for what error occurred.
1351
+ # @return [String]
1352
+ #
1353
+ # @!attribute [rw] analyze_lending_model_version
1354
+ # The current model version of the Analyze Lending API.
1355
+ # @return [String]
1356
+ #
1357
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/GetLendingAnalysisSummaryResponse AWS API Documentation
1358
+ #
1359
+ class GetLendingAnalysisSummaryResponse < Struct.new(
1360
+ :document_metadata,
1361
+ :job_status,
1362
+ :summary,
1363
+ :warnings,
1364
+ :status_message,
1365
+ :analyze_lending_model_version)
1366
+ SENSITIVE = []
1367
+ include Aws::Structure
1368
+ end
1369
+
1152
1370
  # Shows the results of the human in the loop evaluation. If there is no
1153
1371
  # HumanLoopArn, the input did not trigger human review.
1154
1372
  #
@@ -1325,8 +1543,8 @@ module Aws::Textract
1325
1543
  #
1326
1544
  class InternalServerError < Aws::EmptyStructure; end
1327
1545
 
1328
- # An invalid job identifier was passed to GetDocumentAnalysis or to
1329
- # GetDocumentAnalysis.
1546
+ # An invalid job identifier was passed to an asynchronous analysis
1547
+ # operation.
1330
1548
  #
1331
1549
  # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/InvalidJobIdException AWS API Documentation
1332
1550
  #
@@ -1362,6 +1580,130 @@ module Aws::Textract
1362
1580
  #
1363
1581
  class InvalidS3ObjectException < Aws::EmptyStructure; end
1364
1582
 
1583
+ # The results extracted for a lending document.
1584
+ #
1585
+ # @!attribute [rw] text
1586
+ # The text extracted for a detected value in a lending document.
1587
+ # @return [String]
1588
+ #
1589
+ # @!attribute [rw] selection_status
1590
+ # The selection status of a selection element, such as an option
1591
+ # button or check box.
1592
+ # @return [String]
1593
+ #
1594
+ # @!attribute [rw] geometry
1595
+ # Information about where the following items are located on a
1596
+ # document page: detected page, text, key-value pairs, tables, table
1597
+ # cells, and selection elements.
1598
+ # @return [Types::Geometry]
1599
+ #
1600
+ # @!attribute [rw] confidence
1601
+ # The confidence level for the text of a detected value in a lending
1602
+ # document.
1603
+ # @return [Float]
1604
+ #
1605
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LendingDetection AWS API Documentation
1606
+ #
1607
+ class LendingDetection < Struct.new(
1608
+ :text,
1609
+ :selection_status,
1610
+ :geometry,
1611
+ :confidence)
1612
+ SENSITIVE = []
1613
+ include Aws::Structure
1614
+ end
1615
+
1616
+ # Holds the structured data returned by AnalyzeDocument for lending
1617
+ # documents.
1618
+ #
1619
+ # @!attribute [rw] lending_fields
1620
+ # An array of LendingField objects.
1621
+ # @return [Array<Types::LendingField>]
1622
+ #
1623
+ # @!attribute [rw] signature_detections
1624
+ # A list of signatures detected in a lending document.
1625
+ # @return [Array<Types::SignatureDetection>]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LendingDocument AWS API Documentation
1628
+ #
1629
+ class LendingDocument < Struct.new(
1630
+ :lending_fields,
1631
+ :signature_detections)
1632
+ SENSITIVE = []
1633
+ include Aws::Structure
1634
+ end
1635
+
1636
+ # Holds the normalized key-value pairs returned by AnalyzeDocument,
1637
+ # including the document type, detected text, and geometry.
1638
+ #
1639
+ # @!attribute [rw] type
1640
+ # The type of the lending document.
1641
+ # @return [String]
1642
+ #
1643
+ # @!attribute [rw] key_detection
1644
+ # The results extracted for a lending document.
1645
+ # @return [Types::LendingDetection]
1646
+ #
1647
+ # @!attribute [rw] value_detections
1648
+ # An array of LendingDetection objects.
1649
+ # @return [Array<Types::LendingDetection>]
1650
+ #
1651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LendingField AWS API Documentation
1652
+ #
1653
+ class LendingField < Struct.new(
1654
+ :type,
1655
+ :key_detection,
1656
+ :value_detections)
1657
+ SENSITIVE = []
1658
+ include Aws::Structure
1659
+ end
1660
+
1661
+ # Contains the detections for each page analyzed through the Analyze
1662
+ # Lending API.
1663
+ #
1664
+ # @!attribute [rw] page
1665
+ # The page number for a page, with regard to whole submission.
1666
+ # @return [Integer]
1667
+ #
1668
+ # @!attribute [rw] page_classification
1669
+ # The classifier result for a given page.
1670
+ # @return [Types::PageClassification]
1671
+ #
1672
+ # @!attribute [rw] extractions
1673
+ # An array of Extraction to hold structured data. e.g. normalized key
1674
+ # value pairs instead of raw OCR detections .
1675
+ # @return [Array<Types::Extraction>]
1676
+ #
1677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LendingResult AWS API Documentation
1678
+ #
1679
+ class LendingResult < Struct.new(
1680
+ :page,
1681
+ :page_classification,
1682
+ :extractions)
1683
+ SENSITIVE = []
1684
+ include Aws::Structure
1685
+ end
1686
+
1687
+ # Contains information regarding DocumentGroups and
1688
+ # UndetectedDocumentTypes.
1689
+ #
1690
+ # @!attribute [rw] document_groups
1691
+ # Contains an array of all DocumentGroup objects.
1692
+ # @return [Array<Types::DocumentGroup>]
1693
+ #
1694
+ # @!attribute [rw] undetected_document_types
1695
+ # UndetectedDocumentTypes.
1696
+ # @return [Array<String>]
1697
+ #
1698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/LendingSummary AWS API Documentation
1699
+ #
1700
+ class LendingSummary < Struct.new(
1701
+ :document_groups,
1702
+ :undetected_document_types)
1703
+ SENSITIVE = []
1704
+ include Aws::Structure
1705
+ end
1706
+
1365
1707
  # An Amazon Textract service limit was exceeded. For example, if you
1366
1708
  # start too many asynchronous jobs concurrently, calls to start
1367
1709
  # operations (`StartDocumentTextDetection`, for example) raise a
@@ -1433,7 +1775,7 @@ module Aws::Textract
1433
1775
 
1434
1776
  # The Amazon Simple Notification Service (Amazon SNS) topic to which
1435
1777
  # Amazon Textract publishes the completion status of an asynchronous
1436
- # document operation, such as StartDocumentTextDetection.
1778
+ # document operation.
1437
1779
  #
1438
1780
  # @note When making an API call, you may pass NotificationChannel
1439
1781
  # data as a hash:
@@ -1468,9 +1810,9 @@ module Aws::Textract
1468
1810
  # `OutputConfig` is an optional parameter which lets you adjust where
1469
1811
  # your output will be placed. By default, Amazon Textract will store the
1470
1812
  # results internally and can only be accessed by the Get API operations.
1471
- # With OutputConfig enabled, you can set the name of the bucket the
1472
- # output will be sent to and the file prefix of the results where you
1473
- # can download your results. Additionally, you can set the `KMSKeyID`
1813
+ # With `OutputConfig` enabled, you can set the name of the bucket the
1814
+ # output will be sent to the file prefix of the results where you can
1815
+ # download your results. Additionally, you can set the `KMSKeyID`
1474
1816
  # parameter to a customer master key (CMK) to encrypt your output.
1475
1817
  # Without this parameter set Amazon Textract will encrypt server-side
1476
1818
  # using the AWS managed CMK for Amazon S3.
@@ -1516,6 +1858,30 @@ module Aws::Textract
1516
1858
  include Aws::Structure
1517
1859
  end
1518
1860
 
1861
+ # The class assigned to a Page object detected in an input document.
1862
+ # Contains information regarding the predicted type/class of a
1863
+ # document's page and the page number that the Page object was detected
1864
+ # on.
1865
+ #
1866
+ # @!attribute [rw] page_type
1867
+ # The class, or document type, assigned to a detected Page object. The
1868
+ # class, or document type, assigned to a detected Page object.
1869
+ # @return [Array<Types::Prediction>]
1870
+ #
1871
+ # @!attribute [rw] page_number
1872
+ # The page number the value was detected on, relative to Amazon
1873
+ # Textract's starting position.
1874
+ # @return [Array<Types::Prediction>]
1875
+ #
1876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/PageClassification AWS API Documentation
1877
+ #
1878
+ class PageClassification < Struct.new(
1879
+ :page_type,
1880
+ :page_number)
1881
+ SENSITIVE = []
1882
+ include Aws::Structure
1883
+ end
1884
+
1519
1885
  # The X and Y coordinates of a point on a document page. The X and Y
1520
1886
  # values that are returned are ratios of the overall document page size.
1521
1887
  # For example, if the input document is 700 x 200 and the operation
@@ -1544,6 +1910,27 @@ module Aws::Textract
1544
1910
  include Aws::Structure
1545
1911
  end
1546
1912
 
1913
+ # Contains information regarding predicted values returned by Amazon
1914
+ # Textract operations, including the predicted value and the confidence
1915
+ # in the predicted value.
1916
+ #
1917
+ # @!attribute [rw] value
1918
+ # The predicted value of a detected object.
1919
+ # @return [String]
1920
+ #
1921
+ # @!attribute [rw] confidence
1922
+ # Amazon Textract's confidence in its predicted value.
1923
+ # @return [Float]
1924
+ #
1925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/Prediction AWS API Documentation
1926
+ #
1927
+ class Prediction < Struct.new(
1928
+ :value,
1929
+ :confidence)
1930
+ SENSITIVE = []
1931
+ include Aws::Structure
1932
+ end
1933
+
1547
1934
  # The number of requests exceeded your throughput limit. If you want to
1548
1935
  # increase this limit, contact Amazon Textract.
1549
1936
  #
@@ -1700,6 +2087,50 @@ module Aws::Textract
1700
2087
  include Aws::Structure
1701
2088
  end
1702
2089
 
2090
+ # Information regarding a detected signature on a page.
2091
+ #
2092
+ # @!attribute [rw] confidence
2093
+ # The confidence, from 0 to 100, in the predicted values for a
2094
+ # detected signature.
2095
+ # @return [Float]
2096
+ #
2097
+ # @!attribute [rw] geometry
2098
+ # Information about where the following items are located on a
2099
+ # document page: detected page, text, key-value pairs, tables, table
2100
+ # cells, and selection elements.
2101
+ # @return [Types::Geometry]
2102
+ #
2103
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/SignatureDetection AWS API Documentation
2104
+ #
2105
+ class SignatureDetection < Struct.new(
2106
+ :confidence,
2107
+ :geometry)
2108
+ SENSITIVE = []
2109
+ include Aws::Structure
2110
+ end
2111
+
2112
+ # Contains information about the pages of a document, defined by logical
2113
+ # boundary.
2114
+ #
2115
+ # @!attribute [rw] index
2116
+ # The index for a given document in a DocumentGroup of a specific
2117
+ # Type.
2118
+ # @return [Integer]
2119
+ #
2120
+ # @!attribute [rw] pages
2121
+ # An array of page numbers for a for a given document, ordered by
2122
+ # logical boundary.
2123
+ # @return [Array<Integer>]
2124
+ #
2125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/SplitDocument AWS API Documentation
2126
+ #
2127
+ class SplitDocument < Struct.new(
2128
+ :index,
2129
+ :pages)
2130
+ SENSITIVE = []
2131
+ include Aws::Structure
2132
+ end
2133
+
1703
2134
  # @note When making an API call, you may pass StartDocumentAnalysisRequest
1704
2135
  # data as a hash:
1705
2136
  #
@@ -2008,6 +2439,130 @@ module Aws::Textract
2008
2439
  include Aws::Structure
2009
2440
  end
2010
2441
 
2442
+ # @note When making an API call, you may pass StartLendingAnalysisRequest
2443
+ # data as a hash:
2444
+ #
2445
+ # {
2446
+ # document_location: { # required
2447
+ # s3_object: {
2448
+ # bucket: "S3Bucket",
2449
+ # name: "S3ObjectName",
2450
+ # version: "S3ObjectVersion",
2451
+ # },
2452
+ # },
2453
+ # client_request_token: "ClientRequestToken",
2454
+ # job_tag: "JobTag",
2455
+ # notification_channel: {
2456
+ # sns_topic_arn: "SNSTopicArn", # required
2457
+ # role_arn: "RoleArn", # required
2458
+ # },
2459
+ # output_config: {
2460
+ # s3_bucket: "S3Bucket", # required
2461
+ # s3_prefix: "S3ObjectName",
2462
+ # },
2463
+ # kms_key_id: "KMSKeyId",
2464
+ # }
2465
+ #
2466
+ # @!attribute [rw] document_location
2467
+ # The Amazon S3 bucket that contains the document to be processed.
2468
+ # It's used by asynchronous operations.
2469
+ #
2470
+ # The input document can be an image file in JPEG or PNG format. It
2471
+ # can also be a file in PDF format.
2472
+ # @return [Types::DocumentLocation]
2473
+ #
2474
+ # @!attribute [rw] client_request_token
2475
+ # The idempotent token that you use to identify the start request. If
2476
+ # you use the same token with multiple `StartLendingAnalysis`
2477
+ # requests, the same `JobId` is returned. Use `ClientRequestToken` to
2478
+ # prevent the same job from being accidentally started more than once.
2479
+ # For more information, see [Calling Amazon Textract Asynchronous
2480
+ # Operations][1].
2481
+ #
2482
+ #
2483
+ #
2484
+ # [1]: https://docs.aws.amazon.com/textract/latest/dg/api-sync.html
2485
+ # @return [String]
2486
+ #
2487
+ # @!attribute [rw] job_tag
2488
+ # An identifier that you specify to be included in the completion
2489
+ # notification published to the Amazon SNS topic. For example, you can
2490
+ # use `JobTag` to identify the type of document that the completion
2491
+ # notification corresponds to (such as a tax form or a receipt).
2492
+ # @return [String]
2493
+ #
2494
+ # @!attribute [rw] notification_channel
2495
+ # The Amazon Simple Notification Service (Amazon SNS) topic to which
2496
+ # Amazon Textract publishes the completion status of an asynchronous
2497
+ # document operation.
2498
+ # @return [Types::NotificationChannel]
2499
+ #
2500
+ # @!attribute [rw] output_config
2501
+ # Sets whether or not your output will go to a user created bucket.
2502
+ # Used to set the name of the bucket, and the prefix on the output
2503
+ # file.
2504
+ #
2505
+ # `OutputConfig` is an optional parameter which lets you adjust where
2506
+ # your output will be placed. By default, Amazon Textract will store
2507
+ # the results internally and can only be accessed by the Get API
2508
+ # operations. With `OutputConfig` enabled, you can set the name of the
2509
+ # bucket the output will be sent to the file prefix of the results
2510
+ # where you can download your results. Additionally, you can set the
2511
+ # `KMSKeyID` parameter to a customer master key (CMK) to encrypt your
2512
+ # output. Without this parameter set Amazon Textract will encrypt
2513
+ # server-side using the AWS managed CMK for Amazon S3.
2514
+ #
2515
+ # Decryption of Customer Content is necessary for processing of the
2516
+ # documents by Amazon Textract. If your account is opted out under an
2517
+ # AI services opt out policy then all unencrypted Customer Content is
2518
+ # immediately and permanently deleted after the Customer Content has
2519
+ # been processed by the service. No copy of of the output is retained
2520
+ # by Amazon Textract. For information about how to opt out, see [
2521
+ # Managing AI services opt-out policy. ][1]
2522
+ #
2523
+ # For more information on data privacy, see the [Data Privacy FAQ][2].
2524
+ #
2525
+ #
2526
+ #
2527
+ # [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_ai-opt-out.html
2528
+ # [2]: https://aws.amazon.com/compliance/data-privacy-faq/
2529
+ # @return [Types::OutputConfig]
2530
+ #
2531
+ # @!attribute [rw] kms_key_id
2532
+ # The KMS key used to encrypt the inference results. This can be in
2533
+ # either Key ID or Key Alias format. When a KMS key is provided, the
2534
+ # KMS key will be used for server-side encryption of the objects in
2535
+ # the customer bucket. When this parameter is not enabled, the result
2536
+ # will be encrypted server side, using SSE-S3.
2537
+ # @return [String]
2538
+ #
2539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartLendingAnalysisRequest AWS API Documentation
2540
+ #
2541
+ class StartLendingAnalysisRequest < Struct.new(
2542
+ :document_location,
2543
+ :client_request_token,
2544
+ :job_tag,
2545
+ :notification_channel,
2546
+ :output_config,
2547
+ :kms_key_id)
2548
+ SENSITIVE = []
2549
+ include Aws::Structure
2550
+ end
2551
+
2552
+ # @!attribute [rw] job_id
2553
+ # A unique identifier for the lending or text-detection job. The
2554
+ # `JobId` is returned from `StartLendingAnalysis`. A `JobId` value is
2555
+ # only valid for 7 days.
2556
+ # @return [String]
2557
+ #
2558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/StartLendingAnalysisResponse AWS API Documentation
2559
+ #
2560
+ class StartLendingAnalysisResponse < Struct.new(
2561
+ :job_id)
2562
+ SENSITIVE = []
2563
+ include Aws::Structure
2564
+ end
2565
+
2011
2566
  # Amazon Textract is temporarily unable to process the request. Try your
2012
2567
  # call again.
2013
2568
  #
@@ -2015,6 +2570,21 @@ module Aws::Textract
2015
2570
  #
2016
2571
  class ThrottlingException < Aws::EmptyStructure; end
2017
2572
 
2573
+ # A structure containing information about an undetected signature on a
2574
+ # page where it was expected but not found.
2575
+ #
2576
+ # @!attribute [rw] page
2577
+ # The page where a signature was expected but not found.
2578
+ # @return [Integer]
2579
+ #
2580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/UndetectedSignature AWS API Documentation
2581
+ #
2582
+ class UndetectedSignature < Struct.new(
2583
+ :page)
2584
+ SENSITIVE = []
2585
+ include Aws::Structure
2586
+ end
2587
+
2018
2588
  # The format of the input document isn't supported. Documents for
2019
2589
  # operations can be in PNG, JPEG, PDF, or TIFF format.
2020
2590
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-textract/customizations'
52
52
  # @!group service
53
53
  module Aws::Textract
54
54
 
55
- GEM_VERSION = '1.42.0'
55
+ GEM_VERSION = '1.43.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-textract
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.42.0
4
+ version: 1.43.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-11-17 00:00:00.000000000 Z
11
+ date: 2022-11-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core