aws-sdk-comprehend 1.48.0 → 1.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-comprehend/client.rb +392 -3
- data/lib/aws-sdk-comprehend/client_api.rb +143 -1
- data/lib/aws-sdk-comprehend/types.rb +790 -18
- data/lib/aws-sdk-comprehend.rb +1 -1
- metadata +5 -5
@@ -19,13 +19,31 @@ module Aws::Comprehend
|
|
19
19
|
#
|
20
20
|
# {
|
21
21
|
# s3_uri: "S3Uri", # required
|
22
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
22
23
|
# attribute_names: ["AttributeNamesListItem"], # required
|
24
|
+
# annotation_data_s3_uri: "S3Uri",
|
25
|
+
# source_documents_s3_uri: "S3Uri",
|
26
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
23
27
|
# }
|
24
28
|
#
|
25
29
|
# @!attribute [rw] s3_uri
|
26
30
|
# The Amazon S3 location of the augmented manifest file.
|
27
31
|
# @return [String]
|
28
32
|
#
|
33
|
+
# @!attribute [rw] split
|
34
|
+
# The purpose of the data you've provided in the augmented manifest.
|
35
|
+
# You can either train or test this data. If you don't specify, the
|
36
|
+
# default is train.
|
37
|
+
#
|
38
|
+
# TRAIN - all of the documents in the manifest will be used for
|
39
|
+
# training. If no test documents are provided, Amazon Comprehend will
|
40
|
+
# automatically reserve a portion of the training documents for
|
41
|
+
# testing.
|
42
|
+
#
|
43
|
+
# TEST - all of the documents in the manifest will be used for
|
44
|
+
# testing.
|
45
|
+
# @return [String]
|
46
|
+
#
|
29
47
|
# @!attribute [rw] attribute_names
|
30
48
|
# The JSON attribute that contains the annotations for your training
|
31
49
|
# documents. The number of attribute names that you specify depends on
|
@@ -42,11 +60,39 @@ module Aws::Comprehend
|
|
42
60
|
# job.
|
43
61
|
# @return [Array<String>]
|
44
62
|
#
|
63
|
+
# @!attribute [rw] annotation_data_s3_uri
|
64
|
+
# The S3 prefix to the annotation files that are referred in the
|
65
|
+
# augmented manifest file.
|
66
|
+
# @return [String]
|
67
|
+
#
|
68
|
+
# @!attribute [rw] source_documents_s3_uri
|
69
|
+
# The S3 prefix to the source files (PDFs) that are referred to in the
|
70
|
+
# augmented manifest file.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] document_type
|
74
|
+
# The type of augmented manifest. PlainTextDocument or
|
75
|
+
# SemiStructuredDocument. If you don't specify, the default is
|
76
|
+
# PlainTextDocument.
|
77
|
+
#
|
78
|
+
# * `PLAIN_TEXT_DOCUMENT` A document type that represents any unicode
|
79
|
+
# text that is encoded in UTF-8.
|
80
|
+
#
|
81
|
+
# * `SEMI_STRUCTURED_DOCUMENT` A document type with positional and
|
82
|
+
# structural context, like a PDF. For training with Amazon
|
83
|
+
# Comprehend, only PDFs are supported. For inference, Amazon
|
84
|
+
# Comprehend support PDFs, DOCX and TXT.
|
85
|
+
# @return [String]
|
86
|
+
#
|
45
87
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/AugmentedManifestsListItem AWS API Documentation
|
46
88
|
#
|
47
89
|
class AugmentedManifestsListItem < Struct.new(
|
48
90
|
:s3_uri,
|
49
|
-
:
|
91
|
+
:split,
|
92
|
+
:attribute_names,
|
93
|
+
:annotation_data_s3_uri,
|
94
|
+
:source_documents_s3_uri,
|
95
|
+
:document_type)
|
50
96
|
SENSITIVE = []
|
51
97
|
include Aws::Structure
|
52
98
|
end
|
@@ -677,6 +723,7 @@ module Aws::Comprehend
|
|
677
723
|
#
|
678
724
|
# {
|
679
725
|
# document_classifier_name: "ComprehendArnName", # required
|
726
|
+
# version_name: "VersionName",
|
680
727
|
# data_access_role_arn: "IamRoleArn", # required
|
681
728
|
# tags: [
|
682
729
|
# {
|
@@ -687,11 +734,16 @@ module Aws::Comprehend
|
|
687
734
|
# input_data_config: { # required
|
688
735
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
689
736
|
# s3_uri: "S3Uri",
|
737
|
+
# test_s3_uri: "S3Uri",
|
690
738
|
# label_delimiter: "LabelDelimiter",
|
691
739
|
# augmented_manifests: [
|
692
740
|
# {
|
693
741
|
# s3_uri: "S3Uri", # required
|
742
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
694
743
|
# attribute_names: ["AttributeNamesListItem"], # required
|
744
|
+
# annotation_data_s3_uri: "S3Uri",
|
745
|
+
# source_documents_s3_uri: "S3Uri",
|
746
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
695
747
|
# },
|
696
748
|
# ],
|
697
749
|
# },
|
@@ -714,6 +766,14 @@ module Aws::Comprehend
|
|
714
766
|
# The name of the document classifier.
|
715
767
|
# @return [String]
|
716
768
|
#
|
769
|
+
# @!attribute [rw] version_name
|
770
|
+
# The version name given to the newly created classifier. Version
|
771
|
+
# names can have a maximum of 256 characters. Alphanumeric characters,
|
772
|
+
# hyphens (-) and underscores (\_) are allowed. The version name must
|
773
|
+
# be unique among all models with the same classifier name in the
|
774
|
+
# account/AWS Region.
|
775
|
+
# @return [String]
|
776
|
+
#
|
717
777
|
# @!attribute [rw] data_access_role_arn
|
718
778
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
719
779
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -799,6 +859,7 @@ module Aws::Comprehend
|
|
799
859
|
#
|
800
860
|
class CreateDocumentClassifierRequest < Struct.new(
|
801
861
|
:document_classifier_name,
|
862
|
+
:version_name,
|
802
863
|
:data_access_role_arn,
|
803
864
|
:tags,
|
804
865
|
:input_data_config,
|
@@ -912,6 +973,7 @@ module Aws::Comprehend
|
|
912
973
|
#
|
913
974
|
# {
|
914
975
|
# recognizer_name: "ComprehendArnName", # required
|
976
|
+
# version_name: "VersionName",
|
915
977
|
# data_access_role_arn: "IamRoleArn", # required
|
916
978
|
# tags: [
|
917
979
|
# {
|
@@ -928,9 +990,12 @@ module Aws::Comprehend
|
|
928
990
|
# ],
|
929
991
|
# documents: {
|
930
992
|
# s3_uri: "S3Uri", # required
|
993
|
+
# test_s3_uri: "S3Uri",
|
994
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
931
995
|
# },
|
932
996
|
# annotations: {
|
933
997
|
# s3_uri: "S3Uri", # required
|
998
|
+
# test_s3_uri: "S3Uri",
|
934
999
|
# },
|
935
1000
|
# entity_list: {
|
936
1001
|
# s3_uri: "S3Uri", # required
|
@@ -938,7 +1003,11 @@ module Aws::Comprehend
|
|
938
1003
|
# augmented_manifests: [
|
939
1004
|
# {
|
940
1005
|
# s3_uri: "S3Uri", # required
|
1006
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
941
1007
|
# attribute_names: ["AttributeNamesListItem"], # required
|
1008
|
+
# annotation_data_s3_uri: "S3Uri",
|
1009
|
+
# source_documents_s3_uri: "S3Uri",
|
1010
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
942
1011
|
# },
|
943
1012
|
# ],
|
944
1013
|
# },
|
@@ -959,6 +1028,14 @@ module Aws::Comprehend
|
|
959
1028
|
# account/region.
|
960
1029
|
# @return [String]
|
961
1030
|
#
|
1031
|
+
# @!attribute [rw] version_name
|
1032
|
+
# The version name given to the newly created recognizer. Version
|
1033
|
+
# names can be a maximum of 256 characters. Alphanumeric characters,
|
1034
|
+
# hyphens (-) and underscores (\_) are allowed. The version name must
|
1035
|
+
# be unique among all models with the same recognizer name in the
|
1036
|
+
# account/ AWS Region.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
962
1039
|
# @!attribute [rw] data_access_role_arn
|
963
1040
|
# The Amazon Resource Name (ARN) of the AWS Identity and Management
|
964
1041
|
# (IAM) role that grants Amazon Comprehend read access to your input
|
@@ -1031,6 +1108,7 @@ module Aws::Comprehend
|
|
1031
1108
|
#
|
1032
1109
|
class CreateEntityRecognizerRequest < Struct.new(
|
1033
1110
|
:recognizer_name,
|
1111
|
+
:version_name,
|
1034
1112
|
:data_access_role_arn,
|
1035
1113
|
:tags,
|
1036
1114
|
:input_data_config,
|
@@ -1841,6 +1919,19 @@ module Aws::Comprehend
|
|
1841
1919
|
# The identifier assigned to the document classification job.
|
1842
1920
|
# @return [String]
|
1843
1921
|
#
|
1922
|
+
# @!attribute [rw] job_arn
|
1923
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
1924
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
1925
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
1926
|
+
# follows:
|
1927
|
+
#
|
1928
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
1929
|
+
#
|
1930
|
+
# The following is an example job ARN:
|
1931
|
+
#
|
1932
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
1933
|
+
# @return [String]
|
1934
|
+
#
|
1844
1935
|
# @!attribute [rw] job_name
|
1845
1936
|
# The name that you assigned to the document classification job.
|
1846
1937
|
# @return [String]
|
@@ -1910,6 +2001,7 @@ module Aws::Comprehend
|
|
1910
2001
|
#
|
1911
2002
|
class DocumentClassificationJobProperties < Struct.new(
|
1912
2003
|
:job_id,
|
2004
|
+
:job_arn,
|
1913
2005
|
:job_name,
|
1914
2006
|
:job_status,
|
1915
2007
|
:message,
|
@@ -1934,6 +2026,7 @@ module Aws::Comprehend
|
|
1934
2026
|
#
|
1935
2027
|
# {
|
1936
2028
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
2029
|
+
# document_classifier_name: "ComprehendArnName",
|
1937
2030
|
# submit_time_before: Time.now,
|
1938
2031
|
# submit_time_after: Time.now,
|
1939
2032
|
# }
|
@@ -1942,6 +2035,10 @@ module Aws::Comprehend
|
|
1942
2035
|
# Filters the list of classifiers based on status.
|
1943
2036
|
# @return [String]
|
1944
2037
|
#
|
2038
|
+
# @!attribute [rw] document_classifier_name
|
2039
|
+
# The name that you assigned to the document classifier
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
1945
2042
|
# @!attribute [rw] submit_time_before
|
1946
2043
|
# Filters the list of classifiers based on the time that the
|
1947
2044
|
# classifier was submitted for processing. Returns only classifiers
|
@@ -1960,6 +2057,7 @@ module Aws::Comprehend
|
|
1960
2057
|
#
|
1961
2058
|
class DocumentClassifierFilter < Struct.new(
|
1962
2059
|
:status,
|
2060
|
+
:document_classifier_name,
|
1963
2061
|
:submit_time_before,
|
1964
2062
|
:submit_time_after)
|
1965
2063
|
SENSITIVE = []
|
@@ -1977,11 +2075,16 @@ module Aws::Comprehend
|
|
1977
2075
|
# {
|
1978
2076
|
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
1979
2077
|
# s3_uri: "S3Uri",
|
2078
|
+
# test_s3_uri: "S3Uri",
|
1980
2079
|
# label_delimiter: "LabelDelimiter",
|
1981
2080
|
# augmented_manifests: [
|
1982
2081
|
# {
|
1983
2082
|
# s3_uri: "S3Uri", # required
|
2083
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
1984
2084
|
# attribute_names: ["AttributeNamesListItem"], # required
|
2085
|
+
# annotation_data_s3_uri: "S3Uri",
|
2086
|
+
# source_documents_s3_uri: "S3Uri",
|
2087
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
1985
2088
|
# },
|
1986
2089
|
# ],
|
1987
2090
|
# }
|
@@ -2021,6 +2124,13 @@ module Aws::Comprehend
|
|
2021
2124
|
# `COMPREHEND_CSV`.
|
2022
2125
|
# @return [String]
|
2023
2126
|
#
|
2127
|
+
# @!attribute [rw] test_s3_uri
|
2128
|
+
# The Amazon S3 URI for the input data. The Amazon S3 bucket must be
|
2129
|
+
# in the same AWS Region as the API endpoint that you are calling. The
|
2130
|
+
# URI can point to a single input file or it can provide the prefix
|
2131
|
+
# for a collection of input files.
|
2132
|
+
# @return [String]
|
2133
|
+
#
|
2024
2134
|
# @!attribute [rw] label_delimiter
|
2025
2135
|
# Indicates the delimiter used to separate each label for training a
|
2026
2136
|
# multi-label classifier. The default delimiter between labels is a
|
@@ -2045,6 +2155,7 @@ module Aws::Comprehend
|
|
2045
2155
|
class DocumentClassifierInputDataConfig < Struct.new(
|
2046
2156
|
:data_format,
|
2047
2157
|
:s3_uri,
|
2158
|
+
:test_s3_uri,
|
2048
2159
|
:label_delimiter,
|
2049
2160
|
:augmented_manifests)
|
2050
2161
|
SENSITIVE = []
|
@@ -2206,6 +2317,10 @@ module Aws::Comprehend
|
|
2206
2317
|
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
2207
2318
|
# @return [String]
|
2208
2319
|
#
|
2320
|
+
# @!attribute [rw] version_name
|
2321
|
+
# The version name that you assigned to the document classifier.
|
2322
|
+
# @return [String]
|
2323
|
+
#
|
2209
2324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierProperties AWS API Documentation
|
2210
2325
|
#
|
2211
2326
|
class DocumentClassifierProperties < Struct.new(
|
@@ -2224,11 +2339,48 @@ module Aws::Comprehend
|
|
2224
2339
|
:volume_kms_key_id,
|
2225
2340
|
:vpc_config,
|
2226
2341
|
:mode,
|
2227
|
-
:model_kms_key_id
|
2342
|
+
:model_kms_key_id,
|
2343
|
+
:version_name)
|
2228
2344
|
SENSITIVE = [:classifier_metadata]
|
2229
2345
|
include Aws::Structure
|
2230
2346
|
end
|
2231
2347
|
|
2348
|
+
# Describes information about a document classifier and its versions.
|
2349
|
+
#
|
2350
|
+
# @!attribute [rw] document_classifier_name
|
2351
|
+
# The name that you assigned the document classifier.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] number_of_versions
|
2355
|
+
# The number of versions you created.
|
2356
|
+
# @return [Integer]
|
2357
|
+
#
|
2358
|
+
# @!attribute [rw] latest_version_created_at
|
2359
|
+
# The time that the latest document classifier version was submitted
|
2360
|
+
# for processing.
|
2361
|
+
# @return [Time]
|
2362
|
+
#
|
2363
|
+
# @!attribute [rw] latest_version_name
|
2364
|
+
# The version name you assigned to the latest document classifier
|
2365
|
+
# version.
|
2366
|
+
# @return [String]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] latest_version_status
|
2369
|
+
# Provides the status of the latest document classifier version.
|
2370
|
+
# @return [String]
|
2371
|
+
#
|
2372
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentClassifierSummary AWS API Documentation
|
2373
|
+
#
|
2374
|
+
class DocumentClassifierSummary < Struct.new(
|
2375
|
+
:document_classifier_name,
|
2376
|
+
:number_of_versions,
|
2377
|
+
:latest_version_created_at,
|
2378
|
+
:latest_version_name,
|
2379
|
+
:latest_version_status)
|
2380
|
+
SENSITIVE = []
|
2381
|
+
include Aws::Structure
|
2382
|
+
end
|
2383
|
+
|
2232
2384
|
# Specifies one of the label or labels that categorize the document
|
2233
2385
|
# being analyzed.
|
2234
2386
|
#
|
@@ -2250,6 +2402,52 @@ module Aws::Comprehend
|
|
2250
2402
|
include Aws::Structure
|
2251
2403
|
end
|
2252
2404
|
|
2405
|
+
# The input properties for a topic detection job.
|
2406
|
+
#
|
2407
|
+
# @note When making an API call, you may pass DocumentReaderConfig
|
2408
|
+
# data as a hash:
|
2409
|
+
#
|
2410
|
+
# {
|
2411
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
2412
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
2413
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
2414
|
+
# }
|
2415
|
+
#
|
2416
|
+
# @!attribute [rw] document_read_action
|
2417
|
+
# This enum field will start with two values which will apply to PDFs:
|
2418
|
+
#
|
2419
|
+
# * `TEXTRACT_DETECT_DOCUMENT_TEXT` - The service calls
|
2420
|
+
# DetectDocumentText for PDF documents per page.
|
2421
|
+
#
|
2422
|
+
# * `TEXTRACT_ANALYZE_DOCUMENT` - The service calls AnalyzeDocument
|
2423
|
+
# for PDF documents per page.
|
2424
|
+
# @return [String]
|
2425
|
+
#
|
2426
|
+
# @!attribute [rw] document_read_mode
|
2427
|
+
# This enum field provides two values:
|
2428
|
+
#
|
2429
|
+
# * `SERVICE_DEFAULT` - use service defaults for Document reading. For
|
2430
|
+
# Digital PDF it would mean using an internal parser instead of
|
2431
|
+
# Textract APIs
|
2432
|
+
#
|
2433
|
+
# * `FORCE_DOCUMENT_READ_ACTION` - Always use specified action for
|
2434
|
+
# DocumentReadAction, including Digital PDF.
|
2435
|
+
# @return [String]
|
2436
|
+
#
|
2437
|
+
# @!attribute [rw] feature_types
|
2438
|
+
# Specifies how the text in an input file should be processed:
|
2439
|
+
# @return [Array<String>]
|
2440
|
+
#
|
2441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DocumentReaderConfig AWS API Documentation
|
2442
|
+
#
|
2443
|
+
class DocumentReaderConfig < Struct.new(
|
2444
|
+
:document_read_action,
|
2445
|
+
:document_read_mode,
|
2446
|
+
:feature_types)
|
2447
|
+
SENSITIVE = []
|
2448
|
+
include Aws::Structure
|
2449
|
+
end
|
2450
|
+
|
2253
2451
|
# Returns the code for the dominant language in the input text and the
|
2254
2452
|
# level of confidence that Amazon Comprehend has in the accuracy of the
|
2255
2453
|
# detection.
|
@@ -2331,6 +2529,19 @@ module Aws::Comprehend
|
|
2331
2529
|
# The identifier assigned to the dominant language detection job.
|
2332
2530
|
# @return [String]
|
2333
2531
|
#
|
2532
|
+
# @!attribute [rw] job_arn
|
2533
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
2534
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
2535
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
2536
|
+
# ARN is as follows:
|
2537
|
+
#
|
2538
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
2539
|
+
#
|
2540
|
+
# The following is an example job ARN:
|
2541
|
+
#
|
2542
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2543
|
+
# @return [String]
|
2544
|
+
#
|
2334
2545
|
# @!attribute [rw] job_name
|
2335
2546
|
# The name that you assigned to the dominant language detection job.
|
2336
2547
|
# @return [String]
|
@@ -2395,6 +2606,7 @@ module Aws::Comprehend
|
|
2395
2606
|
#
|
2396
2607
|
class DominantLanguageDetectionJobProperties < Struct.new(
|
2397
2608
|
:job_id,
|
2609
|
+
:job_arn,
|
2398
2610
|
:job_name,
|
2399
2611
|
:job_status,
|
2400
2612
|
:message,
|
@@ -2475,6 +2687,12 @@ module Aws::Comprehend
|
|
2475
2687
|
# is attached.
|
2476
2688
|
# @return [String]
|
2477
2689
|
#
|
2690
|
+
# @!attribute [rw] desired_model_arn
|
2691
|
+
# ARN of the new model to use for updating an existing endpoint. This
|
2692
|
+
# ARN is going to be different from the model ARN when the update is
|
2693
|
+
# in progress
|
2694
|
+
# @return [String]
|
2695
|
+
#
|
2478
2696
|
# @!attribute [rw] desired_inference_units
|
2479
2697
|
# The desired number of inference units to be used by the model using
|
2480
2698
|
# this endpoint. Each inference unit represents of a throughput of 100
|
@@ -2501,6 +2719,11 @@ module Aws::Comprehend
|
|
2501
2719
|
# (ModelKmsKeyId).
|
2502
2720
|
# @return [String]
|
2503
2721
|
#
|
2722
|
+
# @!attribute [rw] desired_data_access_role_arn
|
2723
|
+
# Data access role ARN to use in case the new model is encrypted with
|
2724
|
+
# a customer KMS key.
|
2725
|
+
# @return [String]
|
2726
|
+
#
|
2504
2727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EndpointProperties AWS API Documentation
|
2505
2728
|
#
|
2506
2729
|
class EndpointProperties < Struct.new(
|
@@ -2508,11 +2731,13 @@ module Aws::Comprehend
|
|
2508
2731
|
:status,
|
2509
2732
|
:message,
|
2510
2733
|
:model_arn,
|
2734
|
+
:desired_model_arn,
|
2511
2735
|
:desired_inference_units,
|
2512
2736
|
:current_inference_units,
|
2513
2737
|
:creation_time,
|
2514
2738
|
:last_modified_time,
|
2515
|
-
:data_access_role_arn
|
2739
|
+
:data_access_role_arn,
|
2740
|
+
:desired_data_access_role_arn)
|
2516
2741
|
SENSITIVE = []
|
2517
2742
|
include Aws::Structure
|
2518
2743
|
end
|
@@ -2570,6 +2795,19 @@ module Aws::Comprehend
|
|
2570
2795
|
# The identifier assigned to the entities detection job.
|
2571
2796
|
# @return [String]
|
2572
2797
|
#
|
2798
|
+
# @!attribute [rw] job_arn
|
2799
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
2800
|
+
# a unique, fully qualified identifier for the job. It includes the
|
2801
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
2802
|
+
# follows:
|
2803
|
+
#
|
2804
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
2805
|
+
#
|
2806
|
+
# The following is an example job ARN:
|
2807
|
+
#
|
2808
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
2809
|
+
# @return [String]
|
2810
|
+
#
|
2573
2811
|
# @!attribute [rw] job_name
|
2574
2812
|
# The name that you assigned the entities detection job.
|
2575
2813
|
# @return [String]
|
@@ -2642,6 +2880,7 @@ module Aws::Comprehend
|
|
2642
2880
|
#
|
2643
2881
|
class EntitiesDetectionJobProperties < Struct.new(
|
2644
2882
|
:job_id,
|
2883
|
+
:job_arn,
|
2645
2884
|
:job_name,
|
2646
2885
|
:job_status,
|
2647
2886
|
:message,
|
@@ -2730,6 +2969,7 @@ module Aws::Comprehend
|
|
2730
2969
|
#
|
2731
2970
|
# {
|
2732
2971
|
# s3_uri: "S3Uri", # required
|
2972
|
+
# test_s3_uri: "S3Uri",
|
2733
2973
|
# }
|
2734
2974
|
#
|
2735
2975
|
# @!attribute [rw] s3_uri
|
@@ -2738,10 +2978,17 @@ module Aws::Comprehend
|
|
2738
2978
|
# API endpoint that you are calling.
|
2739
2979
|
# @return [String]
|
2740
2980
|
#
|
2981
|
+
# @!attribute [rw] test_s3_uri
|
2982
|
+
# This specifies the Amazon S3 location where the test annotations for
|
2983
|
+
# an entity recognizer are located. The URI must be in the same AWS
|
2984
|
+
# Region as the API endpoint that you are calling.
|
2985
|
+
# @return [String]
|
2986
|
+
#
|
2741
2987
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerAnnotations AWS API Documentation
|
2742
2988
|
#
|
2743
2989
|
class EntityRecognizerAnnotations < Struct.new(
|
2744
|
-
:s3_uri
|
2990
|
+
:s3_uri,
|
2991
|
+
:test_s3_uri)
|
2745
2992
|
SENSITIVE = []
|
2746
2993
|
include Aws::Structure
|
2747
2994
|
end
|
@@ -2753,6 +3000,8 @@ module Aws::Comprehend
|
|
2753
3000
|
#
|
2754
3001
|
# {
|
2755
3002
|
# s3_uri: "S3Uri", # required
|
3003
|
+
# test_s3_uri: "S3Uri",
|
3004
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2756
3005
|
# }
|
2757
3006
|
#
|
2758
3007
|
# @!attribute [rw] s3_uri
|
@@ -2761,10 +3010,28 @@ module Aws::Comprehend
|
|
2761
3010
|
# the API endpoint that you are calling.
|
2762
3011
|
# @return [String]
|
2763
3012
|
#
|
3013
|
+
# @!attribute [rw] test_s3_uri
|
3014
|
+
# Specifies the Amazon S3 location where the test documents for an
|
3015
|
+
# entity recognizer are located. The URI must be in the same AWS
|
3016
|
+
# Region as the API endpoint that you are calling.
|
3017
|
+
# @return [String]
|
3018
|
+
#
|
3019
|
+
# @!attribute [rw] input_format
|
3020
|
+
# Specifies how the text in an input file should be processed. This is
|
3021
|
+
# optional, and the default is ONE\_DOC\_PER\_LINE.
|
3022
|
+
# ONE\_DOC\_PER\_FILE - Each file is considered a separate document.
|
3023
|
+
# Use this option when you are processing large documents, such as
|
3024
|
+
# newspaper articles or scientific papers. ONE\_DOC\_PER\_LINE - Each
|
3025
|
+
# line in a file is considered a separate document. Use this option
|
3026
|
+
# when you are processing many short documents, such as text messages.
|
3027
|
+
# @return [String]
|
3028
|
+
#
|
2764
3029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerDocuments AWS API Documentation
|
2765
3030
|
#
|
2766
3031
|
class EntityRecognizerDocuments < Struct.new(
|
2767
|
-
:s3_uri
|
3032
|
+
:s3_uri,
|
3033
|
+
:test_s3_uri,
|
3034
|
+
:input_format)
|
2768
3035
|
SENSITIVE = []
|
2769
3036
|
include Aws::Structure
|
2770
3037
|
end
|
@@ -2832,6 +3099,7 @@ module Aws::Comprehend
|
|
2832
3099
|
#
|
2833
3100
|
# {
|
2834
3101
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
3102
|
+
# recognizer_name: "ComprehendArnName",
|
2835
3103
|
# submit_time_before: Time.now,
|
2836
3104
|
# submit_time_after: Time.now,
|
2837
3105
|
# }
|
@@ -2840,6 +3108,10 @@ module Aws::Comprehend
|
|
2840
3108
|
# The status of an entity recognizer.
|
2841
3109
|
# @return [String]
|
2842
3110
|
#
|
3111
|
+
# @!attribute [rw] recognizer_name
|
3112
|
+
# The name that you assigned the entity recognizer.
|
3113
|
+
# @return [String]
|
3114
|
+
#
|
2843
3115
|
# @!attribute [rw] submit_time_before
|
2844
3116
|
# Filters the list of entities based on the time that the list was
|
2845
3117
|
# submitted for processing. Returns only jobs submitted before the
|
@@ -2858,6 +3130,7 @@ module Aws::Comprehend
|
|
2858
3130
|
#
|
2859
3131
|
class EntityRecognizerFilter < Struct.new(
|
2860
3132
|
:status,
|
3133
|
+
:recognizer_name,
|
2861
3134
|
:submit_time_before,
|
2862
3135
|
:submit_time_after)
|
2863
3136
|
SENSITIVE = []
|
@@ -2878,9 +3151,12 @@ module Aws::Comprehend
|
|
2878
3151
|
# ],
|
2879
3152
|
# documents: {
|
2880
3153
|
# s3_uri: "S3Uri", # required
|
3154
|
+
# test_s3_uri: "S3Uri",
|
3155
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2881
3156
|
# },
|
2882
3157
|
# annotations: {
|
2883
3158
|
# s3_uri: "S3Uri", # required
|
3159
|
+
# test_s3_uri: "S3Uri",
|
2884
3160
|
# },
|
2885
3161
|
# entity_list: {
|
2886
3162
|
# s3_uri: "S3Uri", # required
|
@@ -2888,7 +3164,11 @@ module Aws::Comprehend
|
|
2888
3164
|
# augmented_manifests: [
|
2889
3165
|
# {
|
2890
3166
|
# s3_uri: "S3Uri", # required
|
3167
|
+
# split: "TRAIN", # accepts TRAIN, TEST
|
2891
3168
|
# attribute_names: ["AttributeNamesListItem"], # required
|
3169
|
+
# annotation_data_s3_uri: "S3Uri",
|
3170
|
+
# source_documents_s3_uri: "S3Uri",
|
3171
|
+
# document_type: "PLAIN_TEXT_DOCUMENT", # accepts PLAIN_TEXT_DOCUMENT, SEMI_STRUCTURED_DOCUMENT
|
2892
3172
|
# },
|
2893
3173
|
# ],
|
2894
3174
|
# }
|
@@ -3116,6 +3396,10 @@ module Aws::Comprehend
|
|
3116
3396
|
# `"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"`
|
3117
3397
|
# @return [String]
|
3118
3398
|
#
|
3399
|
+
# @!attribute [rw] version_name
|
3400
|
+
# The version name you assigned to the entity recognizer.
|
3401
|
+
# @return [String]
|
3402
|
+
#
|
3119
3403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerProperties AWS API Documentation
|
3120
3404
|
#
|
3121
3405
|
class EntityRecognizerProperties < Struct.new(
|
@@ -3132,11 +3416,48 @@ module Aws::Comprehend
|
|
3132
3416
|
:data_access_role_arn,
|
3133
3417
|
:volume_kms_key_id,
|
3134
3418
|
:vpc_config,
|
3135
|
-
:model_kms_key_id
|
3419
|
+
:model_kms_key_id,
|
3420
|
+
:version_name)
|
3136
3421
|
SENSITIVE = [:recognizer_metadata]
|
3137
3422
|
include Aws::Structure
|
3138
3423
|
end
|
3139
3424
|
|
3425
|
+
# Describes the information about an entity recognizer and its versions.
|
3426
|
+
#
|
3427
|
+
# @!attribute [rw] recognizer_name
|
3428
|
+
# The name that you assigned the entity recognizer.
|
3429
|
+
# @return [String]
|
3430
|
+
#
|
3431
|
+
# @!attribute [rw] number_of_versions
|
3432
|
+
# The number of versions you created.
|
3433
|
+
# @return [Integer]
|
3434
|
+
#
|
3435
|
+
# @!attribute [rw] latest_version_created_at
|
3436
|
+
# The time that the latest entity recognizer version was submitted for
|
3437
|
+
# processing.
|
3438
|
+
# @return [Time]
|
3439
|
+
#
|
3440
|
+
# @!attribute [rw] latest_version_name
|
3441
|
+
# The version name you assigned to the latest entity recognizer
|
3442
|
+
# version.
|
3443
|
+
# @return [String]
|
3444
|
+
#
|
3445
|
+
# @!attribute [rw] latest_version_status
|
3446
|
+
# Provides the status of the latest entity recognizer version.
|
3447
|
+
# @return [String]
|
3448
|
+
#
|
3449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/EntityRecognizerSummary AWS API Documentation
|
3450
|
+
#
|
3451
|
+
class EntityRecognizerSummary < Struct.new(
|
3452
|
+
:recognizer_name,
|
3453
|
+
:number_of_versions,
|
3454
|
+
:latest_version_created_at,
|
3455
|
+
:latest_version_name,
|
3456
|
+
:latest_version_status)
|
3457
|
+
SENSITIVE = []
|
3458
|
+
include Aws::Structure
|
3459
|
+
end
|
3460
|
+
|
3140
3461
|
# Detailed information about the accuracy of an entity recognizer for a
|
3141
3462
|
# specific entity type.
|
3142
3463
|
#
|
@@ -3250,6 +3571,19 @@ module Aws::Comprehend
|
|
3250
3571
|
# The identifier assigned to the events detection job.
|
3251
3572
|
# @return [String]
|
3252
3573
|
#
|
3574
|
+
# @!attribute [rw] job_arn
|
3575
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
3576
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
3577
|
+
# account, Region, and the job ID. The format of the ARN is as
|
3578
|
+
# follows:
|
3579
|
+
#
|
3580
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
3581
|
+
#
|
3582
|
+
# The following is an example job ARN:
|
3583
|
+
#
|
3584
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3585
|
+
# @return [String]
|
3586
|
+
#
|
3253
3587
|
# @!attribute [rw] job_name
|
3254
3588
|
# The name you assigned the events detection job.
|
3255
3589
|
# @return [String]
|
@@ -3298,6 +3632,7 @@ module Aws::Comprehend
|
|
3298
3632
|
#
|
3299
3633
|
class EventsDetectionJobProperties < Struct.new(
|
3300
3634
|
:job_id,
|
3635
|
+
:job_arn,
|
3301
3636
|
:job_name,
|
3302
3637
|
:job_status,
|
3303
3638
|
:message,
|
@@ -3312,7 +3647,7 @@ module Aws::Comprehend
|
|
3312
3647
|
include Aws::Structure
|
3313
3648
|
end
|
3314
3649
|
|
3315
|
-
# The input properties for
|
3650
|
+
# The input properties for an inference job.
|
3316
3651
|
#
|
3317
3652
|
# @note When making an API call, you may pass InputDataConfig
|
3318
3653
|
# data as a hash:
|
@@ -3320,6 +3655,11 @@ module Aws::Comprehend
|
|
3320
3655
|
# {
|
3321
3656
|
# s3_uri: "S3Uri", # required
|
3322
3657
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3658
|
+
# document_reader_config: {
|
3659
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
3660
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
3661
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
3662
|
+
# },
|
3323
3663
|
# }
|
3324
3664
|
#
|
3325
3665
|
# @!attribute [rw] s3_uri
|
@@ -3346,11 +3686,21 @@ module Aws::Comprehend
|
|
3346
3686
|
# documents, such as text messages.
|
3347
3687
|
# @return [String]
|
3348
3688
|
#
|
3689
|
+
# @!attribute [rw] document_reader_config
|
3690
|
+
# The document reader config field applies only for InputDataConfig of
|
3691
|
+
# StartEntitiesDetectionJob.
|
3692
|
+
#
|
3693
|
+
# Use DocumentReaderConfig to provide specifications about how you
|
3694
|
+
# want your inference documents read. Currently it applies for PDF
|
3695
|
+
# documents in StartEntitiesDetectionJob custom inference.
|
3696
|
+
# @return [Types::DocumentReaderConfig]
|
3697
|
+
#
|
3349
3698
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/InputDataConfig AWS API Documentation
|
3350
3699
|
#
|
3351
3700
|
class InputDataConfig < Struct.new(
|
3352
3701
|
:s3_uri,
|
3353
|
-
:input_format
|
3702
|
+
:input_format,
|
3703
|
+
:document_reader_config)
|
3354
3704
|
SENSITIVE = []
|
3355
3705
|
include Aws::Structure
|
3356
3706
|
end
|
@@ -3500,6 +3850,19 @@ module Aws::Comprehend
|
|
3500
3850
|
# The identifier assigned to the key phrases detection job.
|
3501
3851
|
# @return [String]
|
3502
3852
|
#
|
3853
|
+
# @!attribute [rw] job_arn
|
3854
|
+
# The Amazon Resource Name (ARN) of the key phrases detection job. It
|
3855
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
3856
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
3857
|
+
# follows:
|
3858
|
+
#
|
3859
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
3860
|
+
#
|
3861
|
+
# The following is an example job ARN:
|
3862
|
+
#
|
3863
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
3864
|
+
# @return [String]
|
3865
|
+
#
|
3503
3866
|
# @!attribute [rw] job_name
|
3504
3867
|
# The name that you assigned the key phrases detection job.
|
3505
3868
|
# @return [String]
|
@@ -3567,6 +3930,7 @@ module Aws::Comprehend
|
|
3567
3930
|
#
|
3568
3931
|
class KeyPhrasesDetectionJobProperties < Struct.new(
|
3569
3932
|
:job_id,
|
3933
|
+
:job_arn,
|
3570
3934
|
:job_name,
|
3571
3935
|
:job_status,
|
3572
3936
|
:message,
|
@@ -3652,12 +4016,56 @@ module Aws::Comprehend
|
|
3652
4016
|
include Aws::Structure
|
3653
4017
|
end
|
3654
4018
|
|
4019
|
+
# @note When making an API call, you may pass ListDocumentClassifierSummariesRequest
|
4020
|
+
# data as a hash:
|
4021
|
+
#
|
4022
|
+
# {
|
4023
|
+
# next_token: "String",
|
4024
|
+
# max_results: 1,
|
4025
|
+
# }
|
4026
|
+
#
|
4027
|
+
# @!attribute [rw] next_token
|
4028
|
+
# Identifies the next page of results to return.
|
4029
|
+
# @return [String]
|
4030
|
+
#
|
4031
|
+
# @!attribute [rw] max_results
|
4032
|
+
# The maximum number of results to return on each page. The default is
|
4033
|
+
# 100.
|
4034
|
+
# @return [Integer]
|
4035
|
+
#
|
4036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummariesRequest AWS API Documentation
|
4037
|
+
#
|
4038
|
+
class ListDocumentClassifierSummariesRequest < Struct.new(
|
4039
|
+
:next_token,
|
4040
|
+
:max_results)
|
4041
|
+
SENSITIVE = []
|
4042
|
+
include Aws::Structure
|
4043
|
+
end
|
4044
|
+
|
4045
|
+
# @!attribute [rw] document_classifier_summaries_list
|
4046
|
+
# The list of summaries of document classifiers.
|
4047
|
+
# @return [Array<Types::DocumentClassifierSummary>]
|
4048
|
+
#
|
4049
|
+
# @!attribute [rw] next_token
|
4050
|
+
# Identifies the next page of results to return.
|
4051
|
+
# @return [String]
|
4052
|
+
#
|
4053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListDocumentClassifierSummariesResponse AWS API Documentation
|
4054
|
+
#
|
4055
|
+
class ListDocumentClassifierSummariesResponse < Struct.new(
|
4056
|
+
:document_classifier_summaries_list,
|
4057
|
+
:next_token)
|
4058
|
+
SENSITIVE = []
|
4059
|
+
include Aws::Structure
|
4060
|
+
end
|
4061
|
+
|
3655
4062
|
# @note When making an API call, you may pass ListDocumentClassifiersRequest
|
3656
4063
|
# data as a hash:
|
3657
4064
|
#
|
3658
4065
|
# {
|
3659
4066
|
# filter: {
|
3660
4067
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
4068
|
+
# document_classifier_name: "ComprehendArnName",
|
3661
4069
|
# submit_time_before: Time.now,
|
3662
4070
|
# submit_time_after: Time.now,
|
3663
4071
|
# },
|
@@ -3876,12 +4284,56 @@ module Aws::Comprehend
|
|
3876
4284
|
include Aws::Structure
|
3877
4285
|
end
|
3878
4286
|
|
4287
|
+
# @note When making an API call, you may pass ListEntityRecognizerSummariesRequest
|
4288
|
+
# data as a hash:
|
4289
|
+
#
|
4290
|
+
# {
|
4291
|
+
# next_token: "String",
|
4292
|
+
# max_results: 1,
|
4293
|
+
# }
|
4294
|
+
#
|
4295
|
+
# @!attribute [rw] next_token
|
4296
|
+
# Identifies the next page of results to return.
|
4297
|
+
# @return [String]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] max_results
|
4300
|
+
# The maximum number of results to return on each page. The default is
|
4301
|
+
# 100.
|
4302
|
+
# @return [Integer]
|
4303
|
+
#
|
4304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesRequest AWS API Documentation
|
4305
|
+
#
|
4306
|
+
class ListEntityRecognizerSummariesRequest < Struct.new(
|
4307
|
+
:next_token,
|
4308
|
+
:max_results)
|
4309
|
+
SENSITIVE = []
|
4310
|
+
include Aws::Structure
|
4311
|
+
end
|
4312
|
+
|
4313
|
+
# @!attribute [rw] entity_recognizer_summaries_list
|
4314
|
+
# The list entity recognizer summaries.
|
4315
|
+
# @return [Array<Types::EntityRecognizerSummary>]
|
4316
|
+
#
|
4317
|
+
# @!attribute [rw] next_token
|
4318
|
+
# The list entity recognizer summaries.
|
4319
|
+
# @return [String]
|
4320
|
+
#
|
4321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEntityRecognizerSummariesResponse AWS API Documentation
|
4322
|
+
#
|
4323
|
+
class ListEntityRecognizerSummariesResponse < Struct.new(
|
4324
|
+
:entity_recognizer_summaries_list,
|
4325
|
+
:next_token)
|
4326
|
+
SENSITIVE = []
|
4327
|
+
include Aws::Structure
|
4328
|
+
end
|
4329
|
+
|
3879
4330
|
# @note When making an API call, you may pass ListEntityRecognizersRequest
|
3880
4331
|
# data as a hash:
|
3881
4332
|
#
|
3882
4333
|
# {
|
3883
4334
|
# filter: {
|
3884
4335
|
# status: "SUBMITTED", # accepts SUBMITTED, TRAINING, DELETING, STOP_REQUESTED, STOPPED, IN_ERROR, TRAINED
|
4336
|
+
# recognizer_name: "ComprehendArnName",
|
3885
4337
|
# submit_time_before: Time.now,
|
3886
4338
|
# submit_time_after: Time.now,
|
3887
4339
|
# },
|
@@ -4376,6 +4828,19 @@ module Aws::Comprehend
|
|
4376
4828
|
# The identifier assigned to the PII entities detection job.
|
4377
4829
|
# @return [String]
|
4378
4830
|
#
|
4831
|
+
# @!attribute [rw] job_arn
|
4832
|
+
# The Amazon Resource Name (ARN) of the PII entities detection job. It
|
4833
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
4834
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
4835
|
+
# follows:
|
4836
|
+
#
|
4837
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
4838
|
+
#
|
4839
|
+
# The following is an example job ARN:
|
4840
|
+
#
|
4841
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
4842
|
+
# @return [String]
|
4843
|
+
#
|
4379
4844
|
# @!attribute [rw] job_name
|
4380
4845
|
# The name that you assigned the PII entities detection job.
|
4381
4846
|
# @return [String]
|
@@ -4433,6 +4898,7 @@ module Aws::Comprehend
|
|
4433
4898
|
#
|
4434
4899
|
class PiiEntitiesDetectionJobProperties < Struct.new(
|
4435
4900
|
:job_id,
|
4901
|
+
:job_arn,
|
4436
4902
|
:job_name,
|
4437
4903
|
:job_status,
|
4438
4904
|
:message,
|
@@ -4654,6 +5120,19 @@ module Aws::Comprehend
|
|
4654
5120
|
# The identifier assigned to the sentiment detection job.
|
4655
5121
|
# @return [String]
|
4656
5122
|
#
|
5123
|
+
# @!attribute [rw] job_arn
|
5124
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
5125
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5126
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5127
|
+
# follows:
|
5128
|
+
#
|
5129
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
5130
|
+
#
|
5131
|
+
# The following is an example job ARN:
|
5132
|
+
#
|
5133
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5134
|
+
# @return [String]
|
5135
|
+
#
|
4657
5136
|
# @!attribute [rw] job_name
|
4658
5137
|
# The name that you assigned to the sentiment detection job
|
4659
5138
|
# @return [String]
|
@@ -4721,6 +5200,7 @@ module Aws::Comprehend
|
|
4721
5200
|
#
|
4722
5201
|
class SentimentDetectionJobProperties < Struct.new(
|
4723
5202
|
:job_id,
|
5203
|
+
:job_arn,
|
4724
5204
|
:job_name,
|
4725
5205
|
:job_status,
|
4726
5206
|
:message,
|
@@ -4779,6 +5259,11 @@ module Aws::Comprehend
|
|
4779
5259
|
# input_data_config: { # required
|
4780
5260
|
# s3_uri: "S3Uri", # required
|
4781
5261
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5262
|
+
# document_reader_config: {
|
5263
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
5264
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
5265
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
5266
|
+
# },
|
4782
5267
|
# },
|
4783
5268
|
# output_data_config: { # required
|
4784
5269
|
# s3_uri: "S3Uri", # required
|
@@ -4791,6 +5276,12 @@ module Aws::Comprehend
|
|
4791
5276
|
# security_group_ids: ["SecurityGroupId"], # required
|
4792
5277
|
# subnets: ["SubnetId"], # required
|
4793
5278
|
# },
|
5279
|
+
# tags: [
|
5280
|
+
# {
|
5281
|
+
# key: "TagKey", # required
|
5282
|
+
# value: "TagValue",
|
5283
|
+
# },
|
5284
|
+
# ],
|
4794
5285
|
# }
|
4795
5286
|
#
|
4796
5287
|
# @!attribute [rw] job_name
|
@@ -4846,6 +5337,13 @@ module Aws::Comprehend
|
|
4846
5337
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4847
5338
|
# @return [Types::VpcConfig]
|
4848
5339
|
#
|
5340
|
+
# @!attribute [rw] tags
|
5341
|
+
# Tags to be associated with the document classification job. A tag is
|
5342
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
5343
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5344
|
+
# added to a resource to indicate its use by the sales department.
|
5345
|
+
# @return [Array<Types::Tag>]
|
5346
|
+
#
|
4849
5347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDocumentClassificationJobRequest AWS API Documentation
|
4850
5348
|
#
|
4851
5349
|
class StartDocumentClassificationJobRequest < Struct.new(
|
@@ -4856,7 +5354,8 @@ module Aws::Comprehend
|
|
4856
5354
|
:data_access_role_arn,
|
4857
5355
|
:client_request_token,
|
4858
5356
|
:volume_kms_key_id,
|
4859
|
-
:vpc_config
|
5357
|
+
:vpc_config,
|
5358
|
+
:tags)
|
4860
5359
|
SENSITIVE = []
|
4861
5360
|
include Aws::Structure
|
4862
5361
|
end
|
@@ -4866,6 +5365,19 @@ module Aws::Comprehend
|
|
4866
5365
|
# use this identifier with the operation.
|
4867
5366
|
# @return [String]
|
4868
5367
|
#
|
5368
|
+
# @!attribute [rw] job_arn
|
5369
|
+
# The Amazon Resource Name (ARN) of the document classification job.
|
5370
|
+
# It is a unique, fully qualified identifier for the job. It includes
|
5371
|
+
# the AWS account, Region, and the job ID. The format of the ARN is as
|
5372
|
+
# follows:
|
5373
|
+
#
|
5374
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:document-classification-job/<job-id>`
|
5375
|
+
#
|
5376
|
+
# The following is an example job ARN:
|
5377
|
+
#
|
5378
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
5379
|
+
# @return [String]
|
5380
|
+
#
|
4869
5381
|
# @!attribute [rw] job_status
|
4870
5382
|
# The status of the job:
|
4871
5383
|
#
|
@@ -4888,6 +5400,7 @@ module Aws::Comprehend
|
|
4888
5400
|
#
|
4889
5401
|
class StartDocumentClassificationJobResponse < Struct.new(
|
4890
5402
|
:job_id,
|
5403
|
+
:job_arn,
|
4891
5404
|
:job_status)
|
4892
5405
|
SENSITIVE = []
|
4893
5406
|
include Aws::Structure
|
@@ -4900,6 +5413,11 @@ module Aws::Comprehend
|
|
4900
5413
|
# input_data_config: { # required
|
4901
5414
|
# s3_uri: "S3Uri", # required
|
4902
5415
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5416
|
+
# document_reader_config: {
|
5417
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
5418
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
5419
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
5420
|
+
# },
|
4903
5421
|
# },
|
4904
5422
|
# output_data_config: { # required
|
4905
5423
|
# s3_uri: "S3Uri", # required
|
@@ -4913,6 +5431,12 @@ module Aws::Comprehend
|
|
4913
5431
|
# security_group_ids: ["SecurityGroupId"], # required
|
4914
5432
|
# subnets: ["SubnetId"], # required
|
4915
5433
|
# },
|
5434
|
+
# tags: [
|
5435
|
+
# {
|
5436
|
+
# key: "TagKey", # required
|
5437
|
+
# value: "TagValue",
|
5438
|
+
# },
|
5439
|
+
# ],
|
4916
5440
|
# }
|
4917
5441
|
#
|
4918
5442
|
# @!attribute [rw] input_data_config
|
@@ -4968,6 +5492,14 @@ module Aws::Comprehend
|
|
4968
5492
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
4969
5493
|
# @return [Types::VpcConfig]
|
4970
5494
|
#
|
5495
|
+
# @!attribute [rw] tags
|
5496
|
+
# Tags to be associated with the dominant language detection job. A
|
5497
|
+
# tag is a key-value pair that adds metadata to a resource used by
|
5498
|
+
# Amazon Comprehend. For example, a tag with "Sales" as the key
|
5499
|
+
# might be added to a resource to indicate its use by the sales
|
5500
|
+
# department.
|
5501
|
+
# @return [Array<Types::Tag>]
|
5502
|
+
#
|
4971
5503
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartDominantLanguageDetectionJobRequest AWS API Documentation
|
4972
5504
|
#
|
4973
5505
|
class StartDominantLanguageDetectionJobRequest < Struct.new(
|
@@ -4977,7 +5509,8 @@ module Aws::Comprehend
|
|
4977
5509
|
:job_name,
|
4978
5510
|
:client_request_token,
|
4979
5511
|
:volume_kms_key_id,
|
4980
|
-
:vpc_config
|
5512
|
+
:vpc_config,
|
5513
|
+
:tags)
|
4981
5514
|
SENSITIVE = []
|
4982
5515
|
include Aws::Structure
|
4983
5516
|
end
|
@@ -4987,6 +5520,19 @@ module Aws::Comprehend
|
|
4987
5520
|
# use this identifier with the operation.
|
4988
5521
|
# @return [String]
|
4989
5522
|
#
|
5523
|
+
# @!attribute [rw] job_arn
|
5524
|
+
# The Amazon Resource Name (ARN) of the dominant language detection
|
5525
|
+
# job. It is a unique, fully qualified identifier for the job. It
|
5526
|
+
# includes the AWS account, Region, and the job ID. The format of the
|
5527
|
+
# ARN is as follows:
|
5528
|
+
#
|
5529
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:dominant-language-detection-job/<job-id>`
|
5530
|
+
#
|
5531
|
+
# The following is an example job ARN:
|
5532
|
+
#
|
5533
|
+
# `arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5534
|
+
# @return [String]
|
5535
|
+
#
|
4990
5536
|
# @!attribute [rw] job_status
|
4991
5537
|
# The status of the job.
|
4992
5538
|
#
|
@@ -5006,6 +5552,7 @@ module Aws::Comprehend
|
|
5006
5552
|
#
|
5007
5553
|
class StartDominantLanguageDetectionJobResponse < Struct.new(
|
5008
5554
|
:job_id,
|
5555
|
+
:job_arn,
|
5009
5556
|
:job_status)
|
5010
5557
|
SENSITIVE = []
|
5011
5558
|
include Aws::Structure
|
@@ -5018,6 +5565,11 @@ module Aws::Comprehend
|
|
5018
5565
|
# input_data_config: { # required
|
5019
5566
|
# s3_uri: "S3Uri", # required
|
5020
5567
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5568
|
+
# document_reader_config: {
|
5569
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
5570
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
5571
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
5572
|
+
# },
|
5021
5573
|
# },
|
5022
5574
|
# output_data_config: { # required
|
5023
5575
|
# s3_uri: "S3Uri", # required
|
@@ -5033,6 +5585,12 @@ module Aws::Comprehend
|
|
5033
5585
|
# security_group_ids: ["SecurityGroupId"], # required
|
5034
5586
|
# subnets: ["SubnetId"], # required
|
5035
5587
|
# },
|
5588
|
+
# tags: [
|
5589
|
+
# {
|
5590
|
+
# key: "TagKey", # required
|
5591
|
+
# value: "TagValue",
|
5592
|
+
# },
|
5593
|
+
# ],
|
5036
5594
|
# }
|
5037
5595
|
#
|
5038
5596
|
# @!attribute [rw] input_data_config
|
@@ -5102,6 +5660,13 @@ module Aws::Comprehend
|
|
5102
5660
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5103
5661
|
# @return [Types::VpcConfig]
|
5104
5662
|
#
|
5663
|
+
# @!attribute [rw] tags
|
5664
|
+
# Tags to be associated with the entities detection job. A tag is a
|
5665
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5666
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5667
|
+
# added to a resource to indicate its use by the sales department.
|
5668
|
+
# @return [Array<Types::Tag>]
|
5669
|
+
#
|
5105
5670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEntitiesDetectionJobRequest AWS API Documentation
|
5106
5671
|
#
|
5107
5672
|
class StartEntitiesDetectionJobRequest < Struct.new(
|
@@ -5113,7 +5678,8 @@ module Aws::Comprehend
|
|
5113
5678
|
:language_code,
|
5114
5679
|
:client_request_token,
|
5115
5680
|
:volume_kms_key_id,
|
5116
|
-
:vpc_config
|
5681
|
+
:vpc_config,
|
5682
|
+
:tags)
|
5117
5683
|
SENSITIVE = []
|
5118
5684
|
include Aws::Structure
|
5119
5685
|
end
|
@@ -5123,6 +5689,19 @@ module Aws::Comprehend
|
|
5123
5689
|
# this identifier with the operation.
|
5124
5690
|
# @return [String]
|
5125
5691
|
#
|
5692
|
+
# @!attribute [rw] job_arn
|
5693
|
+
# The Amazon Resource Name (ARN) of the entities detection job. It is
|
5694
|
+
# a unique, fully qualified identifier for the job. It includes the
|
5695
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5696
|
+
# follows:
|
5697
|
+
#
|
5698
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>`
|
5699
|
+
#
|
5700
|
+
# The following is an example job ARN:
|
5701
|
+
#
|
5702
|
+
# `arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5703
|
+
# @return [String]
|
5704
|
+
#
|
5126
5705
|
# @!attribute [rw] job_status
|
5127
5706
|
# The status of the job.
|
5128
5707
|
#
|
@@ -5147,6 +5726,7 @@ module Aws::Comprehend
|
|
5147
5726
|
#
|
5148
5727
|
class StartEntitiesDetectionJobResponse < Struct.new(
|
5149
5728
|
:job_id,
|
5729
|
+
:job_arn,
|
5150
5730
|
:job_status)
|
5151
5731
|
SENSITIVE = []
|
5152
5732
|
include Aws::Structure
|
@@ -5159,6 +5739,11 @@ module Aws::Comprehend
|
|
5159
5739
|
# input_data_config: { # required
|
5160
5740
|
# s3_uri: "S3Uri", # required
|
5161
5741
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5742
|
+
# document_reader_config: {
|
5743
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
5744
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
5745
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
5746
|
+
# },
|
5162
5747
|
# },
|
5163
5748
|
# output_data_config: { # required
|
5164
5749
|
# s3_uri: "S3Uri", # required
|
@@ -5169,6 +5754,12 @@ module Aws::Comprehend
|
|
5169
5754
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5170
5755
|
# client_request_token: "ClientRequestTokenString",
|
5171
5756
|
# target_event_types: ["EventTypeString"], # required
|
5757
|
+
# tags: [
|
5758
|
+
# {
|
5759
|
+
# key: "TagKey", # required
|
5760
|
+
# value: "TagValue",
|
5761
|
+
# },
|
5762
|
+
# ],
|
5172
5763
|
# }
|
5173
5764
|
#
|
5174
5765
|
# @!attribute [rw] input_data_config
|
@@ -5205,6 +5796,13 @@ module Aws::Comprehend
|
|
5205
5796
|
# The types of events to detect in the input documents.
|
5206
5797
|
# @return [Array<String>]
|
5207
5798
|
#
|
5799
|
+
# @!attribute [rw] tags
|
5800
|
+
# Tags to be associated with the events detection job. A tag is a
|
5801
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5802
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5803
|
+
# added to a resource to indicate its use by the sales department.
|
5804
|
+
# @return [Array<Types::Tag>]
|
5805
|
+
#
|
5208
5806
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJobRequest AWS API Documentation
|
5209
5807
|
#
|
5210
5808
|
class StartEventsDetectionJobRequest < Struct.new(
|
@@ -5214,7 +5812,8 @@ module Aws::Comprehend
|
|
5214
5812
|
:job_name,
|
5215
5813
|
:language_code,
|
5216
5814
|
:client_request_token,
|
5217
|
-
:target_event_types
|
5815
|
+
:target_event_types,
|
5816
|
+
:tags)
|
5218
5817
|
SENSITIVE = []
|
5219
5818
|
include Aws::Structure
|
5220
5819
|
end
|
@@ -5224,6 +5823,19 @@ module Aws::Comprehend
|
|
5224
5823
|
# request token, Amazon Comprehend generates one.
|
5225
5824
|
# @return [String]
|
5226
5825
|
#
|
5826
|
+
# @!attribute [rw] job_arn
|
5827
|
+
# The Amazon Resource Name (ARN) of the events detection job. It is a
|
5828
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
5829
|
+
# account, Region, and the job ID. The format of the ARN is as
|
5830
|
+
# follows:
|
5831
|
+
#
|
5832
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:events-detection-job/<job-id>`
|
5833
|
+
#
|
5834
|
+
# The following is an example job ARN:
|
5835
|
+
#
|
5836
|
+
# `arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5837
|
+
# @return [String]
|
5838
|
+
#
|
5227
5839
|
# @!attribute [rw] job_status
|
5228
5840
|
# The status of the events detection job.
|
5229
5841
|
# @return [String]
|
@@ -5232,6 +5844,7 @@ module Aws::Comprehend
|
|
5232
5844
|
#
|
5233
5845
|
class StartEventsDetectionJobResponse < Struct.new(
|
5234
5846
|
:job_id,
|
5847
|
+
:job_arn,
|
5235
5848
|
:job_status)
|
5236
5849
|
SENSITIVE = []
|
5237
5850
|
include Aws::Structure
|
@@ -5244,6 +5857,11 @@ module Aws::Comprehend
|
|
5244
5857
|
# input_data_config: { # required
|
5245
5858
|
# s3_uri: "S3Uri", # required
|
5246
5859
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
5860
|
+
# document_reader_config: {
|
5861
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
5862
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
5863
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
5864
|
+
# },
|
5247
5865
|
# },
|
5248
5866
|
# output_data_config: { # required
|
5249
5867
|
# s3_uri: "S3Uri", # required
|
@@ -5258,6 +5876,12 @@ module Aws::Comprehend
|
|
5258
5876
|
# security_group_ids: ["SecurityGroupId"], # required
|
5259
5877
|
# subnets: ["SubnetId"], # required
|
5260
5878
|
# },
|
5879
|
+
# tags: [
|
5880
|
+
# {
|
5881
|
+
# key: "TagKey", # required
|
5882
|
+
# value: "TagValue",
|
5883
|
+
# },
|
5884
|
+
# ],
|
5261
5885
|
# }
|
5262
5886
|
#
|
5263
5887
|
# @!attribute [rw] input_data_config
|
@@ -5319,6 +5943,13 @@ module Aws::Comprehend
|
|
5319
5943
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5320
5944
|
# @return [Types::VpcConfig]
|
5321
5945
|
#
|
5946
|
+
# @!attribute [rw] tags
|
5947
|
+
# Tags to be associated with the key phrases detection job. A tag is a
|
5948
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
5949
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
5950
|
+
# added to a resource to indicate its use by the sales department.
|
5951
|
+
# @return [Array<Types::Tag>]
|
5952
|
+
#
|
5322
5953
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartKeyPhrasesDetectionJobRequest AWS API Documentation
|
5323
5954
|
#
|
5324
5955
|
class StartKeyPhrasesDetectionJobRequest < Struct.new(
|
@@ -5329,7 +5960,8 @@ module Aws::Comprehend
|
|
5329
5960
|
:language_code,
|
5330
5961
|
:client_request_token,
|
5331
5962
|
:volume_kms_key_id,
|
5332
|
-
:vpc_config
|
5963
|
+
:vpc_config,
|
5964
|
+
:tags)
|
5333
5965
|
SENSITIVE = []
|
5334
5966
|
include Aws::Structure
|
5335
5967
|
end
|
@@ -5339,6 +5971,19 @@ module Aws::Comprehend
|
|
5339
5971
|
# use this identifier with the operation.
|
5340
5972
|
# @return [String]
|
5341
5973
|
#
|
5974
|
+
# @!attribute [rw] job_arn
|
5975
|
+
# The Amazon Resource Name (ARN) of the key phrase detection job. It
|
5976
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
5977
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
5978
|
+
# follows:
|
5979
|
+
#
|
5980
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:key-phrases-detection-job/<job-id>`
|
5981
|
+
#
|
5982
|
+
# The following is an example job ARN:
|
5983
|
+
#
|
5984
|
+
# `arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
5985
|
+
# @return [String]
|
5986
|
+
#
|
5342
5987
|
# @!attribute [rw] job_status
|
5343
5988
|
# The status of the job.
|
5344
5989
|
#
|
@@ -5358,6 +6003,7 @@ module Aws::Comprehend
|
|
5358
6003
|
#
|
5359
6004
|
class StartKeyPhrasesDetectionJobResponse < Struct.new(
|
5360
6005
|
:job_id,
|
6006
|
+
:job_arn,
|
5361
6007
|
:job_status)
|
5362
6008
|
SENSITIVE = []
|
5363
6009
|
include Aws::Structure
|
@@ -5370,6 +6016,11 @@ module Aws::Comprehend
|
|
5370
6016
|
# input_data_config: { # required
|
5371
6017
|
# s3_uri: "S3Uri", # required
|
5372
6018
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
6019
|
+
# document_reader_config: {
|
6020
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
6021
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
6022
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
6023
|
+
# },
|
5373
6024
|
# },
|
5374
6025
|
# output_data_config: { # required
|
5375
6026
|
# s3_uri: "S3Uri", # required
|
@@ -5385,6 +6036,12 @@ module Aws::Comprehend
|
|
5385
6036
|
# job_name: "JobName",
|
5386
6037
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
5387
6038
|
# client_request_token: "ClientRequestTokenString",
|
6039
|
+
# tags: [
|
6040
|
+
# {
|
6041
|
+
# key: "TagKey", # required
|
6042
|
+
# value: "TagValue",
|
6043
|
+
# },
|
6044
|
+
# ],
|
5388
6045
|
# }
|
5389
6046
|
#
|
5390
6047
|
# @!attribute [rw] input_data_config
|
@@ -5431,6 +6088,13 @@ module Aws::Comprehend
|
|
5431
6088
|
# not need to pass this option.
|
5432
6089
|
# @return [String]
|
5433
6090
|
#
|
6091
|
+
# @!attribute [rw] tags
|
6092
|
+
# Tags to be associated with the PII entities detection job. A tag is
|
6093
|
+
# a key-value pair that adds metadata to a resource used by Amazon
|
6094
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
6095
|
+
# added to a resource to indicate its use by the sales department.
|
6096
|
+
# @return [Array<Types::Tag>]
|
6097
|
+
#
|
5434
6098
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
|
5435
6099
|
#
|
5436
6100
|
class StartPiiEntitiesDetectionJobRequest < Struct.new(
|
@@ -5441,7 +6105,8 @@ module Aws::Comprehend
|
|
5441
6105
|
:data_access_role_arn,
|
5442
6106
|
:job_name,
|
5443
6107
|
:language_code,
|
5444
|
-
:client_request_token
|
6108
|
+
:client_request_token,
|
6109
|
+
:tags)
|
5445
6110
|
SENSITIVE = []
|
5446
6111
|
include Aws::Structure
|
5447
6112
|
end
|
@@ -5450,6 +6115,19 @@ module Aws::Comprehend
|
|
5450
6115
|
# The identifier generated for the job.
|
5451
6116
|
# @return [String]
|
5452
6117
|
#
|
6118
|
+
# @!attribute [rw] job_arn
|
6119
|
+
# The Amazon Resource Name (ARN) of the PII entity detection job. It
|
6120
|
+
# is a unique, fully qualified identifier for the job. It includes the
|
6121
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
6122
|
+
# follows:
|
6123
|
+
#
|
6124
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>`
|
6125
|
+
#
|
6126
|
+
# The following is an example job ARN:
|
6127
|
+
#
|
6128
|
+
# `arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
6129
|
+
# @return [String]
|
6130
|
+
#
|
5453
6131
|
# @!attribute [rw] job_status
|
5454
6132
|
# The status of the job.
|
5455
6133
|
# @return [String]
|
@@ -5458,6 +6136,7 @@ module Aws::Comprehend
|
|
5458
6136
|
#
|
5459
6137
|
class StartPiiEntitiesDetectionJobResponse < Struct.new(
|
5460
6138
|
:job_id,
|
6139
|
+
:job_arn,
|
5461
6140
|
:job_status)
|
5462
6141
|
SENSITIVE = []
|
5463
6142
|
include Aws::Structure
|
@@ -5470,6 +6149,11 @@ module Aws::Comprehend
|
|
5470
6149
|
# input_data_config: { # required
|
5471
6150
|
# s3_uri: "S3Uri", # required
|
5472
6151
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
6152
|
+
# document_reader_config: {
|
6153
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
6154
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
6155
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
6156
|
+
# },
|
5473
6157
|
# },
|
5474
6158
|
# output_data_config: { # required
|
5475
6159
|
# s3_uri: "S3Uri", # required
|
@@ -5484,6 +6168,12 @@ module Aws::Comprehend
|
|
5484
6168
|
# security_group_ids: ["SecurityGroupId"], # required
|
5485
6169
|
# subnets: ["SubnetId"], # required
|
5486
6170
|
# },
|
6171
|
+
# tags: [
|
6172
|
+
# {
|
6173
|
+
# key: "TagKey", # required
|
6174
|
+
# value: "TagValue",
|
6175
|
+
# },
|
6176
|
+
# ],
|
5487
6177
|
# }
|
5488
6178
|
#
|
5489
6179
|
# @!attribute [rw] input_data_config
|
@@ -5545,6 +6235,13 @@ module Aws::Comprehend
|
|
5545
6235
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5546
6236
|
# @return [Types::VpcConfig]
|
5547
6237
|
#
|
6238
|
+
# @!attribute [rw] tags
|
6239
|
+
# Tags to be associated with the sentiment detection job. A tag is a
|
6240
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
6241
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
6242
|
+
# added to a resource to indicate its use by the sales department.
|
6243
|
+
# @return [Array<Types::Tag>]
|
6244
|
+
#
|
5548
6245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJobRequest AWS API Documentation
|
5549
6246
|
#
|
5550
6247
|
class StartSentimentDetectionJobRequest < Struct.new(
|
@@ -5555,7 +6252,8 @@ module Aws::Comprehend
|
|
5555
6252
|
:language_code,
|
5556
6253
|
:client_request_token,
|
5557
6254
|
:volume_kms_key_id,
|
5558
|
-
:vpc_config
|
6255
|
+
:vpc_config,
|
6256
|
+
:tags)
|
5559
6257
|
SENSITIVE = []
|
5560
6258
|
include Aws::Structure
|
5561
6259
|
end
|
@@ -5565,6 +6263,19 @@ module Aws::Comprehend
|
|
5565
6263
|
# use this identifier with the operation.
|
5566
6264
|
# @return [String]
|
5567
6265
|
#
|
6266
|
+
# @!attribute [rw] job_arn
|
6267
|
+
# The Amazon Resource Name (ARN) of the sentiment detection job. It is
|
6268
|
+
# a unique, fully qualified identifier for the job. It includes the
|
6269
|
+
# AWS account, Region, and the job ID. The format of the ARN is as
|
6270
|
+
# follows:
|
6271
|
+
#
|
6272
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:sentiment-detection-job/<job-id>`
|
6273
|
+
#
|
6274
|
+
# The following is an example job ARN:
|
6275
|
+
#
|
6276
|
+
# `arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
6277
|
+
# @return [String]
|
6278
|
+
#
|
5568
6279
|
# @!attribute [rw] job_status
|
5569
6280
|
# The status of the job.
|
5570
6281
|
#
|
@@ -5584,6 +6295,7 @@ module Aws::Comprehend
|
|
5584
6295
|
#
|
5585
6296
|
class StartSentimentDetectionJobResponse < Struct.new(
|
5586
6297
|
:job_id,
|
6298
|
+
:job_arn,
|
5587
6299
|
:job_status)
|
5588
6300
|
SENSITIVE = []
|
5589
6301
|
include Aws::Structure
|
@@ -5596,6 +6308,11 @@ module Aws::Comprehend
|
|
5596
6308
|
# input_data_config: { # required
|
5597
6309
|
# s3_uri: "S3Uri", # required
|
5598
6310
|
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
6311
|
+
# document_reader_config: {
|
6312
|
+
# document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
|
6313
|
+
# document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
|
6314
|
+
# feature_types: ["TABLES"], # accepts TABLES, FORMS
|
6315
|
+
# },
|
5599
6316
|
# },
|
5600
6317
|
# output_data_config: { # required
|
5601
6318
|
# s3_uri: "S3Uri", # required
|
@@ -5610,6 +6327,12 @@ module Aws::Comprehend
|
|
5610
6327
|
# security_group_ids: ["SecurityGroupId"], # required
|
5611
6328
|
# subnets: ["SubnetId"], # required
|
5612
6329
|
# },
|
6330
|
+
# tags: [
|
6331
|
+
# {
|
6332
|
+
# key: "TagKey", # required
|
6333
|
+
# value: "TagValue",
|
6334
|
+
# },
|
6335
|
+
# ],
|
5613
6336
|
# }
|
5614
6337
|
#
|
5615
6338
|
# @!attribute [rw] input_data_config
|
@@ -5672,6 +6395,13 @@ module Aws::Comprehend
|
|
5672
6395
|
# [1]: https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html
|
5673
6396
|
# @return [Types::VpcConfig]
|
5674
6397
|
#
|
6398
|
+
# @!attribute [rw] tags
|
6399
|
+
# Tags to be associated with the topics detection job. A tag is a
|
6400
|
+
# key-value pair that adds metadata to a resource used by Amazon
|
6401
|
+
# Comprehend. For example, a tag with "Sales" as the key might be
|
6402
|
+
# added to a resource to indicate its use by the sales department.
|
6403
|
+
# @return [Array<Types::Tag>]
|
6404
|
+
#
|
5675
6405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJobRequest AWS API Documentation
|
5676
6406
|
#
|
5677
6407
|
class StartTopicsDetectionJobRequest < Struct.new(
|
@@ -5682,7 +6412,8 @@ module Aws::Comprehend
|
|
5682
6412
|
:number_of_topics,
|
5683
6413
|
:client_request_token,
|
5684
6414
|
:volume_kms_key_id,
|
5685
|
-
:vpc_config
|
6415
|
+
:vpc_config,
|
6416
|
+
:tags)
|
5686
6417
|
SENSITIVE = []
|
5687
6418
|
include Aws::Structure
|
5688
6419
|
end
|
@@ -5692,6 +6423,19 @@ module Aws::Comprehend
|
|
5692
6423
|
# use this identifier with the `DescribeTopicDetectionJob` operation.
|
5693
6424
|
# @return [String]
|
5694
6425
|
#
|
6426
|
+
# @!attribute [rw] job_arn
|
6427
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6428
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6429
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6430
|
+
# follows:
|
6431
|
+
#
|
6432
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6433
|
+
#
|
6434
|
+
# The following is an example job ARN:
|
6435
|
+
#
|
6436
|
+
# `arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab`
|
6437
|
+
# @return [String]
|
6438
|
+
#
|
5695
6439
|
# @!attribute [rw] job_status
|
5696
6440
|
# The status of the job:
|
5697
6441
|
#
|
@@ -5711,6 +6455,7 @@ module Aws::Comprehend
|
|
5711
6455
|
#
|
5712
6456
|
class StartTopicsDetectionJobResponse < Struct.new(
|
5713
6457
|
:job_id,
|
6458
|
+
:job_arn,
|
5714
6459
|
:job_status)
|
5715
6460
|
SENSITIVE = []
|
5716
6461
|
include Aws::Structure
|
@@ -6210,6 +6955,19 @@ module Aws::Comprehend
|
|
6210
6955
|
# The identifier assigned to the topic detection job.
|
6211
6956
|
# @return [String]
|
6212
6957
|
#
|
6958
|
+
# @!attribute [rw] job_arn
|
6959
|
+
# The Amazon Resource Name (ARN) of the topics detection job. It is a
|
6960
|
+
# unique, fully qualified identifier for the job. It includes the AWS
|
6961
|
+
# account, Region, and the job ID. The format of the ARN is as
|
6962
|
+
# follows:
|
6963
|
+
#
|
6964
|
+
# `arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>`
|
6965
|
+
#
|
6966
|
+
# The following is an example job ARN:
|
6967
|
+
#
|
6968
|
+
# `arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab`
|
6969
|
+
# @return [String]
|
6970
|
+
#
|
6213
6971
|
# @!attribute [rw] job_name
|
6214
6972
|
# The name of the topic detection job.
|
6215
6973
|
# @return [String]
|
@@ -6279,6 +7037,7 @@ module Aws::Comprehend
|
|
6279
7037
|
#
|
6280
7038
|
class TopicsDetectionJobProperties < Struct.new(
|
6281
7039
|
:job_id,
|
7040
|
+
:job_arn,
|
6282
7041
|
:job_name,
|
6283
7042
|
:job_status,
|
6284
7043
|
:message,
|
@@ -6349,24 +7108,37 @@ module Aws::Comprehend
|
|
6349
7108
|
#
|
6350
7109
|
# {
|
6351
7110
|
# endpoint_arn: "ComprehendEndpointArn", # required
|
6352
|
-
#
|
7111
|
+
# desired_model_arn: "ComprehendModelArn",
|
7112
|
+
# desired_inference_units: 1,
|
7113
|
+
# desired_data_access_role_arn: "IamRoleArn",
|
6353
7114
|
# }
|
6354
7115
|
#
|
6355
7116
|
# @!attribute [rw] endpoint_arn
|
6356
7117
|
# The Amazon Resource Number (ARN) of the endpoint being updated.
|
6357
7118
|
# @return [String]
|
6358
7119
|
#
|
7120
|
+
# @!attribute [rw] desired_model_arn
|
7121
|
+
# The ARN of the new model to use when updating an existing endpoint.
|
7122
|
+
# @return [String]
|
7123
|
+
#
|
6359
7124
|
# @!attribute [rw] desired_inference_units
|
6360
7125
|
# The desired number of inference units to be used by the model using
|
6361
7126
|
# this endpoint. Each inference unit represents of a throughput of 100
|
6362
7127
|
# characters per second.
|
6363
7128
|
# @return [Integer]
|
6364
7129
|
#
|
7130
|
+
# @!attribute [rw] desired_data_access_role_arn
|
7131
|
+
# Data access role ARN to use in case the new model is encrypted with
|
7132
|
+
# a customer CMK.
|
7133
|
+
# @return [String]
|
7134
|
+
#
|
6365
7135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/UpdateEndpointRequest AWS API Documentation
|
6366
7136
|
#
|
6367
7137
|
class UpdateEndpointRequest < Struct.new(
|
6368
7138
|
:endpoint_arn,
|
6369
|
-
:
|
7139
|
+
:desired_model_arn,
|
7140
|
+
:desired_inference_units,
|
7141
|
+
:desired_data_access_role_arn)
|
6370
7142
|
SENSITIVE = []
|
6371
7143
|
include Aws::Structure
|
6372
7144
|
end
|