aws-sdk-comprehend 1.38.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-comprehend.rb +1 -1
- data/lib/aws-sdk-comprehend/client.rb +493 -3
- data/lib/aws-sdk-comprehend/client_api.rb +312 -2
- data/lib/aws-sdk-comprehend/types.rb +1008 -41
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e62520828260762780f91a6410bd9b134354e1208b50690e7aed28db59a3c478
|
4
|
+
data.tar.gz: 47f3fd763c2a90000aa7c9d11460be53ae19d2a920c5bad7db115a0b7dd21528
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8f3e219e9df089e539e5bb61aa624ce124dc7242fda2043819431a632ffe9e89136ddedc1afdf15a5ab64578d427fee5cc6d7b9ff4b798a4e55d35c46d81519f
|
7
|
+
data.tar.gz: d14558d5100811e8231c398c6513259e49e3f526688ebcb49a462a5ea6db4c447ee7b3fd108c221bdfef13f6856a3c65b43d2f3ae013957466660e61bb95f257
|
data/lib/aws-sdk-comprehend.rb
CHANGED
@@ -706,8 +706,15 @@ module Aws::Comprehend
|
|
706
706
|
# },
|
707
707
|
# ],
|
708
708
|
# input_data_config: { # required
|
709
|
-
#
|
709
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
710
|
+
# s3_uri: "S3Uri",
|
710
711
|
# label_delimiter: "LabelDelimiter",
|
712
|
+
# augmented_manifests: [
|
713
|
+
# {
|
714
|
+
# s3_uri: "S3Uri", # required
|
715
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
716
|
+
# },
|
717
|
+
# ],
|
711
718
|
# },
|
712
719
|
# output_data_config: {
|
713
720
|
# s3_uri: "S3Uri",
|
@@ -873,12 +880,13 @@ module Aws::Comprehend
|
|
873
880
|
# },
|
874
881
|
# ],
|
875
882
|
# input_data_config: { # required
|
883
|
+
# data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
|
876
884
|
# entity_types: [ # required
|
877
885
|
# {
|
878
886
|
# type: "EntityTypeName", # required
|
879
887
|
# },
|
880
888
|
# ],
|
881
|
-
# documents: {
|
889
|
+
# documents: {
|
882
890
|
# s3_uri: "S3Uri", # required
|
883
891
|
# },
|
884
892
|
# annotations: {
|
@@ -887,6 +895,12 @@ module Aws::Comprehend
|
|
887
895
|
# entity_list: {
|
888
896
|
# s3_uri: "S3Uri", # required
|
889
897
|
# },
|
898
|
+
# augmented_manifests: [
|
899
|
+
# {
|
900
|
+
# s3_uri: "S3Uri", # required
|
901
|
+
# attribute_names: ["AttributeNamesListItem"], # required
|
902
|
+
# },
|
903
|
+
# ],
|
890
904
|
# },
|
891
905
|
# client_request_token: "ClientRequestTokenString",
|
892
906
|
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
@@ -1069,8 +1083,13 @@ module Aws::Comprehend
|
|
1069
1083
|
# resp.document_classifier_properties.end_time #=> Time
|
1070
1084
|
# resp.document_classifier_properties.training_start_time #=> Time
|
1071
1085
|
# resp.document_classifier_properties.training_end_time #=> Time
|
1086
|
+
# resp.document_classifier_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1072
1087
|
# resp.document_classifier_properties.input_data_config.s3_uri #=> String
|
1073
1088
|
# resp.document_classifier_properties.input_data_config.label_delimiter #=> String
|
1089
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests #=> Array
|
1090
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1091
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1092
|
+
# resp.document_classifier_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1074
1093
|
# resp.document_classifier_properties.output_data_config.s3_uri #=> String
|
1075
1094
|
# resp.document_classifier_properties.output_data_config.kms_key_id #=> String
|
1076
1095
|
# resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
|
@@ -1256,11 +1275,16 @@ module Aws::Comprehend
|
|
1256
1275
|
# resp.entity_recognizer_properties.end_time #=> Time
|
1257
1276
|
# resp.entity_recognizer_properties.training_start_time #=> Time
|
1258
1277
|
# resp.entity_recognizer_properties.training_end_time #=> Time
|
1278
|
+
# resp.entity_recognizer_properties.input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1259
1279
|
# resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
|
1260
1280
|
# resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
|
1261
1281
|
# resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
|
1262
1282
|
# resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
|
1263
1283
|
# resp.entity_recognizer_properties.input_data_config.entity_list.s3_uri #=> String
|
1284
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests #=> Array
|
1285
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].s3_uri #=> String
|
1286
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1287
|
+
# resp.entity_recognizer_properties.input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1264
1288
|
# resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
|
1265
1289
|
# resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
|
1266
1290
|
# resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
|
@@ -1288,6 +1312,47 @@ module Aws::Comprehend
|
|
1288
1312
|
req.send_request(options)
|
1289
1313
|
end
|
1290
1314
|
|
1315
|
+
# Gets the status and details of an events detection job.
|
1316
|
+
#
|
1317
|
+
# @option params [required, String] :job_id
|
1318
|
+
# The identifier of the events detection job.
|
1319
|
+
#
|
1320
|
+
# @return [Types::DescribeEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
|
+
#
|
1322
|
+
# * {Types::DescribeEventsDetectionJobResponse#events_detection_job_properties #events_detection_job_properties} => Types::EventsDetectionJobProperties
|
1323
|
+
#
|
1324
|
+
# @example Request syntax with placeholder values
|
1325
|
+
#
|
1326
|
+
# resp = client.describe_events_detection_job({
|
1327
|
+
# job_id: "JobId", # required
|
1328
|
+
# })
|
1329
|
+
#
|
1330
|
+
# @example Response structure
|
1331
|
+
#
|
1332
|
+
# resp.events_detection_job_properties.job_id #=> String
|
1333
|
+
# resp.events_detection_job_properties.job_name #=> String
|
1334
|
+
# resp.events_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1335
|
+
# resp.events_detection_job_properties.message #=> String
|
1336
|
+
# resp.events_detection_job_properties.submit_time #=> Time
|
1337
|
+
# resp.events_detection_job_properties.end_time #=> Time
|
1338
|
+
# resp.events_detection_job_properties.input_data_config.s3_uri #=> String
|
1339
|
+
# resp.events_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1340
|
+
# resp.events_detection_job_properties.output_data_config.s3_uri #=> String
|
1341
|
+
# resp.events_detection_job_properties.output_data_config.kms_key_id #=> String
|
1342
|
+
# resp.events_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1343
|
+
# resp.events_detection_job_properties.data_access_role_arn #=> String
|
1344
|
+
# resp.events_detection_job_properties.target_event_types #=> Array
|
1345
|
+
# resp.events_detection_job_properties.target_event_types[0] #=> String
|
1346
|
+
#
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribeEventsDetectionJob AWS API Documentation
|
1348
|
+
#
|
1349
|
+
# @overload describe_events_detection_job(params = {})
|
1350
|
+
# @param [Hash] params ({})
|
1351
|
+
def describe_events_detection_job(params = {}, options = {})
|
1352
|
+
req = build_request(:describe_events_detection_job, params)
|
1353
|
+
req.send_request(options)
|
1354
|
+
end
|
1355
|
+
|
1291
1356
|
# Gets the properties associated with a key phrases detection job. Use
|
1292
1357
|
# this operation to get the status of a detection job.
|
1293
1358
|
#
|
@@ -1334,6 +1399,52 @@ module Aws::Comprehend
|
|
1334
1399
|
req.send_request(options)
|
1335
1400
|
end
|
1336
1401
|
|
1402
|
+
# Gets the properties associated with a PII entities detection job. For
|
1403
|
+
# example, you can use this operation to get the job status.
|
1404
|
+
#
|
1405
|
+
# @option params [required, String] :job_id
|
1406
|
+
# The identifier that Amazon Comprehend generated for the job. The
|
1407
|
+
# operation returns this identifier in its response.
|
1408
|
+
#
|
1409
|
+
# @return [Types::DescribePiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1410
|
+
#
|
1411
|
+
# * {Types::DescribePiiEntitiesDetectionJobResponse#pii_entities_detection_job_properties #pii_entities_detection_job_properties} => Types::PiiEntitiesDetectionJobProperties
|
1412
|
+
#
|
1413
|
+
# @example Request syntax with placeholder values
|
1414
|
+
#
|
1415
|
+
# resp = client.describe_pii_entities_detection_job({
|
1416
|
+
# job_id: "JobId", # required
|
1417
|
+
# })
|
1418
|
+
#
|
1419
|
+
# @example Response structure
|
1420
|
+
#
|
1421
|
+
# resp.pii_entities_detection_job_properties.job_id #=> String
|
1422
|
+
# resp.pii_entities_detection_job_properties.job_name #=> String
|
1423
|
+
# resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
1424
|
+
# resp.pii_entities_detection_job_properties.message #=> String
|
1425
|
+
# resp.pii_entities_detection_job_properties.submit_time #=> Time
|
1426
|
+
# resp.pii_entities_detection_job_properties.end_time #=> Time
|
1427
|
+
# resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
|
1428
|
+
# resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
1429
|
+
# resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
|
1430
|
+
# resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
|
1431
|
+
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
|
1432
|
+
# resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
1433
|
+
# resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
|
1434
|
+
# resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
|
1435
|
+
# resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
1436
|
+
# resp.pii_entities_detection_job_properties.data_access_role_arn #=> String
|
1437
|
+
# resp.pii_entities_detection_job_properties.mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
|
1438
|
+
#
|
1439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob AWS API Documentation
|
1440
|
+
#
|
1441
|
+
# @overload describe_pii_entities_detection_job(params = {})
|
1442
|
+
# @param [Hash] params ({})
|
1443
|
+
def describe_pii_entities_detection_job(params = {}, options = {})
|
1444
|
+
req = build_request(:describe_pii_entities_detection_job, params)
|
1445
|
+
req.send_request(options)
|
1446
|
+
end
|
1447
|
+
|
1337
1448
|
# Gets the properties associated with a sentiment detection job. Use
|
1338
1449
|
# this operation to get the status of a detection job.
|
1339
1450
|
#
|
@@ -1557,6 +1668,44 @@ module Aws::Comprehend
|
|
1557
1668
|
req.send_request(options)
|
1558
1669
|
end
|
1559
1670
|
|
1671
|
+
# Inspects the input text for entities that contain personally
|
1672
|
+
# identifiable information (PII) and returns information about them.
|
1673
|
+
#
|
1674
|
+
# @option params [required, String] :text
|
1675
|
+
# A UTF-8 text string. Each string must contain fewer that 5,000 bytes
|
1676
|
+
# of UTF-8 encoded characters.
|
1677
|
+
#
|
1678
|
+
# @option params [required, String] :language_code
|
1679
|
+
# The language of the input documents.
|
1680
|
+
#
|
1681
|
+
# @return [Types::DetectPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1682
|
+
#
|
1683
|
+
# * {Types::DetectPiiEntitiesResponse#entities #entities} => Array<Types::PiiEntity>
|
1684
|
+
#
|
1685
|
+
# @example Request syntax with placeholder values
|
1686
|
+
#
|
1687
|
+
# resp = client.detect_pii_entities({
|
1688
|
+
# text: "String", # required
|
1689
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
1690
|
+
# })
|
1691
|
+
#
|
1692
|
+
# @example Response structure
|
1693
|
+
#
|
1694
|
+
# resp.entities #=> Array
|
1695
|
+
# resp.entities[0].score #=> Float
|
1696
|
+
# resp.entities[0].type #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
1697
|
+
# resp.entities[0].begin_offset #=> Integer
|
1698
|
+
# resp.entities[0].end_offset #=> Integer
|
1699
|
+
#
|
1700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities AWS API Documentation
|
1701
|
+
#
|
1702
|
+
# @overload detect_pii_entities(params = {})
|
1703
|
+
# @param [Hash] params ({})
|
1704
|
+
def detect_pii_entities(params = {}, options = {})
|
1705
|
+
req = build_request(:detect_pii_entities, params)
|
1706
|
+
req.send_request(options)
|
1707
|
+
end
|
1708
|
+
|
1560
1709
|
# Inspects text and returns an inference of the prevailing sentiment
|
1561
1710
|
# (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
|
1562
1711
|
#
|
@@ -1751,8 +1900,13 @@ module Aws::Comprehend
|
|
1751
1900
|
# resp.document_classifier_properties_list[0].end_time #=> Time
|
1752
1901
|
# resp.document_classifier_properties_list[0].training_start_time #=> Time
|
1753
1902
|
# resp.document_classifier_properties_list[0].training_end_time #=> Time
|
1903
|
+
# resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
1754
1904
|
# resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
|
1755
1905
|
# resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
|
1906
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
|
1907
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
1908
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
1909
|
+
# resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
1756
1910
|
# resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
|
1757
1911
|
# resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
|
1758
1912
|
# resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
|
@@ -2020,11 +2174,16 @@ module Aws::Comprehend
|
|
2020
2174
|
# resp.entity_recognizer_properties_list[0].end_time #=> Time
|
2021
2175
|
# resp.entity_recognizer_properties_list[0].training_start_time #=> Time
|
2022
2176
|
# resp.entity_recognizer_properties_list[0].training_end_time #=> Time
|
2177
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
|
2023
2178
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
|
2024
2179
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
|
2025
2180
|
# resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
|
2026
2181
|
# resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
|
2027
2182
|
# resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
|
2183
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
|
2184
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
|
2185
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
|
2186
|
+
# resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
|
2028
2187
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
|
2029
2188
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
|
2030
2189
|
# resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
|
@@ -2053,6 +2212,67 @@ module Aws::Comprehend
|
|
2053
2212
|
req.send_request(options)
|
2054
2213
|
end
|
2055
2214
|
|
2215
|
+
# Gets a list of the events detection jobs that you have submitted.
|
2216
|
+
#
|
2217
|
+
# @option params [Types::EventsDetectionJobFilter] :filter
|
2218
|
+
# Filters the jobs that are returned. You can filter jobs on their name,
|
2219
|
+
# status, or the date and time that they were submitted. You can only
|
2220
|
+
# set one filter at a time.
|
2221
|
+
#
|
2222
|
+
# @option params [String] :next_token
|
2223
|
+
# Identifies the next page of results to return.
|
2224
|
+
#
|
2225
|
+
# @option params [Integer] :max_results
|
2226
|
+
# The maximum number of results to return in each page.
|
2227
|
+
#
|
2228
|
+
# @return [Types::ListEventsDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2229
|
+
#
|
2230
|
+
# * {Types::ListEventsDetectionJobsResponse#events_detection_job_properties_list #events_detection_job_properties_list} => Array<Types::EventsDetectionJobProperties>
|
2231
|
+
# * {Types::ListEventsDetectionJobsResponse#next_token #next_token} => String
|
2232
|
+
#
|
2233
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2234
|
+
#
|
2235
|
+
# @example Request syntax with placeholder values
|
2236
|
+
#
|
2237
|
+
# resp = client.list_events_detection_jobs({
|
2238
|
+
# filter: {
|
2239
|
+
# job_name: "JobName",
|
2240
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
2241
|
+
# submit_time_before: Time.now,
|
2242
|
+
# submit_time_after: Time.now,
|
2243
|
+
# },
|
2244
|
+
# next_token: "String",
|
2245
|
+
# max_results: 1,
|
2246
|
+
# })
|
2247
|
+
#
|
2248
|
+
# @example Response structure
|
2249
|
+
#
|
2250
|
+
# resp.events_detection_job_properties_list #=> Array
|
2251
|
+
# resp.events_detection_job_properties_list[0].job_id #=> String
|
2252
|
+
# resp.events_detection_job_properties_list[0].job_name #=> String
|
2253
|
+
# resp.events_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2254
|
+
# resp.events_detection_job_properties_list[0].message #=> String
|
2255
|
+
# resp.events_detection_job_properties_list[0].submit_time #=> Time
|
2256
|
+
# resp.events_detection_job_properties_list[0].end_time #=> Time
|
2257
|
+
# resp.events_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2258
|
+
# resp.events_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2259
|
+
# resp.events_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2260
|
+
# resp.events_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2261
|
+
# resp.events_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
2262
|
+
# resp.events_detection_job_properties_list[0].data_access_role_arn #=> String
|
2263
|
+
# resp.events_detection_job_properties_list[0].target_event_types #=> Array
|
2264
|
+
# resp.events_detection_job_properties_list[0].target_event_types[0] #=> String
|
2265
|
+
# resp.next_token #=> String
|
2266
|
+
#
|
2267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListEventsDetectionJobs AWS API Documentation
|
2268
|
+
#
|
2269
|
+
# @overload list_events_detection_jobs(params = {})
|
2270
|
+
# @param [Hash] params ({})
|
2271
|
+
def list_events_detection_jobs(params = {}, options = {})
|
2272
|
+
req = build_request(:list_events_detection_jobs, params)
|
2273
|
+
req.send_request(options)
|
2274
|
+
end
|
2275
|
+
|
2056
2276
|
# Get a list of key phrase detection jobs that you have submitted.
|
2057
2277
|
#
|
2058
2278
|
# @option params [Types::KeyPhrasesDetectionJobFilter] :filter
|
@@ -2118,6 +2338,68 @@ module Aws::Comprehend
|
|
2118
2338
|
req.send_request(options)
|
2119
2339
|
end
|
2120
2340
|
|
2341
|
+
# Gets a list of the PII entity detection jobs that you have submitted.
|
2342
|
+
#
|
2343
|
+
# @option params [Types::PiiEntitiesDetectionJobFilter] :filter
|
2344
|
+
# Filters the jobs that are returned. You can filter jobs on their name,
|
2345
|
+
# status, or the date and time that they were submitted. You can only
|
2346
|
+
# set one filter at a time.
|
2347
|
+
#
|
2348
|
+
# @option params [String] :next_token
|
2349
|
+
# Identifies the next page of results to return.
|
2350
|
+
#
|
2351
|
+
# @option params [Integer] :max_results
|
2352
|
+
# The maximum number of results to return in each page.
|
2353
|
+
#
|
2354
|
+
# @return [Types::ListPiiEntitiesDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2355
|
+
#
|
2356
|
+
# * {Types::ListPiiEntitiesDetectionJobsResponse#pii_entities_detection_job_properties_list #pii_entities_detection_job_properties_list} => Array<Types::PiiEntitiesDetectionJobProperties>
|
2357
|
+
# * {Types::ListPiiEntitiesDetectionJobsResponse#next_token #next_token} => String
|
2358
|
+
#
|
2359
|
+
# @example Request syntax with placeholder values
|
2360
|
+
#
|
2361
|
+
# resp = client.list_pii_entities_detection_jobs({
|
2362
|
+
# filter: {
|
2363
|
+
# job_name: "JobName",
|
2364
|
+
# job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
|
2365
|
+
# submit_time_before: Time.now,
|
2366
|
+
# submit_time_after: Time.now,
|
2367
|
+
# },
|
2368
|
+
# next_token: "String",
|
2369
|
+
# max_results: 1,
|
2370
|
+
# })
|
2371
|
+
#
|
2372
|
+
# @example Response structure
|
2373
|
+
#
|
2374
|
+
# resp.pii_entities_detection_job_properties_list #=> Array
|
2375
|
+
# resp.pii_entities_detection_job_properties_list[0].job_id #=> String
|
2376
|
+
# resp.pii_entities_detection_job_properties_list[0].job_name #=> String
|
2377
|
+
# resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2378
|
+
# resp.pii_entities_detection_job_properties_list[0].message #=> String
|
2379
|
+
# resp.pii_entities_detection_job_properties_list[0].submit_time #=> Time
|
2380
|
+
# resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
|
2381
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
|
2382
|
+
# resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
|
2383
|
+
# resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
|
2384
|
+
# resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
|
2385
|
+
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
|
2386
|
+
# resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types[0] #=> String, one of "BANK_ACCOUNT_NUMBER", "BANK_ROUTING", "CREDIT_DEBIT_NUMBER", "CREDIT_DEBIT_CVV", "CREDIT_DEBIT_EXPIRY", "PIN", "EMAIL", "ADDRESS", "NAME", "PHONE", "SSN", "DATE_TIME", "PASSPORT_NUMBER", "DRIVER_ID", "URL", "AGE", "USERNAME", "PASSWORD", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "IP_ADDRESS", "MAC_ADDRESS", "ALL"
|
2387
|
+
# resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
|
2388
|
+
# resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
|
2389
|
+
# resp.pii_entities_detection_job_properties_list[0].language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
|
2390
|
+
# resp.pii_entities_detection_job_properties_list[0].data_access_role_arn #=> String
|
2391
|
+
# resp.pii_entities_detection_job_properties_list[0].mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
|
2392
|
+
# resp.next_token #=> String
|
2393
|
+
#
|
2394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs AWS API Documentation
|
2395
|
+
#
|
2396
|
+
# @overload list_pii_entities_detection_jobs(params = {})
|
2397
|
+
# @param [Hash] params ({})
|
2398
|
+
def list_pii_entities_detection_jobs(params = {}, options = {})
|
2399
|
+
req = build_request(:list_pii_entities_detection_jobs, params)
|
2400
|
+
req.send_request(options)
|
2401
|
+
end
|
2402
|
+
|
2121
2403
|
# Gets a list of sentiment detection jobs that you have submitted.
|
2122
2404
|
#
|
2123
2405
|
# @option params [Types::SentimentDetectionJobFilter] :filter
|
@@ -2567,6 +2849,73 @@ module Aws::Comprehend
|
|
2567
2849
|
req.send_request(options)
|
2568
2850
|
end
|
2569
2851
|
|
2852
|
+
# Starts an asynchronous event detection job for a collection of
|
2853
|
+
# documents.
|
2854
|
+
#
|
2855
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
2856
|
+
# Specifies the format and location of the input data for the job.
|
2857
|
+
#
|
2858
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
2859
|
+
# Specifies where to send the output files.
|
2860
|
+
#
|
2861
|
+
# @option params [required, String] :data_access_role_arn
|
2862
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
2863
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
2864
|
+
# your input data.
|
2865
|
+
#
|
2866
|
+
# @option params [String] :job_name
|
2867
|
+
# The identifier of the events detection job.
|
2868
|
+
#
|
2869
|
+
# @option params [required, String] :language_code
|
2870
|
+
# The language code of the input documents.
|
2871
|
+
#
|
2872
|
+
# @option params [String] :client_request_token
|
2873
|
+
# An unique identifier for the request. If you don't set the client
|
2874
|
+
# request token, Amazon Comprehend generates one.
|
2875
|
+
#
|
2876
|
+
# **A suitable default value is auto-generated.** You should normally
|
2877
|
+
# not need to pass this option.**
|
2878
|
+
#
|
2879
|
+
# @option params [required, Array<String>] :target_event_types
|
2880
|
+
# The types of events to detect in the input documents.
|
2881
|
+
#
|
2882
|
+
# @return [Types::StartEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2883
|
+
#
|
2884
|
+
# * {Types::StartEventsDetectionJobResponse#job_id #job_id} => String
|
2885
|
+
# * {Types::StartEventsDetectionJobResponse#job_status #job_status} => String
|
2886
|
+
#
|
2887
|
+
# @example Request syntax with placeholder values
|
2888
|
+
#
|
2889
|
+
# resp = client.start_events_detection_job({
|
2890
|
+
# input_data_config: { # required
|
2891
|
+
# s3_uri: "S3Uri", # required
|
2892
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
2893
|
+
# },
|
2894
|
+
# output_data_config: { # required
|
2895
|
+
# s3_uri: "S3Uri", # required
|
2896
|
+
# kms_key_id: "KmsKeyId",
|
2897
|
+
# },
|
2898
|
+
# data_access_role_arn: "IamRoleArn", # required
|
2899
|
+
# job_name: "JobName",
|
2900
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
2901
|
+
# client_request_token: "ClientRequestTokenString",
|
2902
|
+
# target_event_types: ["EventTypeString"], # required
|
2903
|
+
# })
|
2904
|
+
#
|
2905
|
+
# @example Response structure
|
2906
|
+
#
|
2907
|
+
# resp.job_id #=> String
|
2908
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
2909
|
+
#
|
2910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartEventsDetectionJob AWS API Documentation
|
2911
|
+
#
|
2912
|
+
# @overload start_events_detection_job(params = {})
|
2913
|
+
# @param [Hash] params ({})
|
2914
|
+
def start_events_detection_job(params = {}, options = {})
|
2915
|
+
req = build_request(:start_events_detection_job, params)
|
2916
|
+
req.send_request(options)
|
2917
|
+
end
|
2918
|
+
|
2570
2919
|
# Starts an asynchronous key phrase detection job for a collection of
|
2571
2920
|
# documents. Use the operation to track the status of a job.
|
2572
2921
|
#
|
@@ -2662,6 +3011,87 @@ module Aws::Comprehend
|
|
2662
3011
|
req.send_request(options)
|
2663
3012
|
end
|
2664
3013
|
|
3014
|
+
# Starts an asynchronous PII entity detection job for a collection of
|
3015
|
+
# documents.
|
3016
|
+
#
|
3017
|
+
# @option params [required, Types::InputDataConfig] :input_data_config
|
3018
|
+
# The input properties for a PII entities detection job.
|
3019
|
+
#
|
3020
|
+
# @option params [required, Types::OutputDataConfig] :output_data_config
|
3021
|
+
# Provides configuration parameters for the output of PII entity
|
3022
|
+
# detection jobs.
|
3023
|
+
#
|
3024
|
+
# @option params [required, String] :mode
|
3025
|
+
# Specifies whether the output provides the locations (offsets) of PII
|
3026
|
+
# entities or a file in which PII entities are redacted.
|
3027
|
+
#
|
3028
|
+
# @option params [Types::RedactionConfig] :redaction_config
|
3029
|
+
# Provides configuration parameters for PII entity redaction.
|
3030
|
+
#
|
3031
|
+
# This parameter is required if you set the `Mode` parameter to
|
3032
|
+
# `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
|
3033
|
+
# definition that includes the `PiiEntityTypes` parameter.
|
3034
|
+
#
|
3035
|
+
# @option params [required, String] :data_access_role_arn
|
3036
|
+
# The Amazon Resource Name (ARN) of the AWS Identity and Access
|
3037
|
+
# Management (IAM) role that grants Amazon Comprehend read access to
|
3038
|
+
# your input data.
|
3039
|
+
#
|
3040
|
+
# @option params [String] :job_name
|
3041
|
+
# The identifier of the job.
|
3042
|
+
#
|
3043
|
+
# @option params [required, String] :language_code
|
3044
|
+
# The language of the input documents.
|
3045
|
+
#
|
3046
|
+
# @option params [String] :client_request_token
|
3047
|
+
# A unique identifier for the request. If you don't set the client
|
3048
|
+
# request token, Amazon Comprehend generates one.
|
3049
|
+
#
|
3050
|
+
# **A suitable default value is auto-generated.** You should normally
|
3051
|
+
# not need to pass this option.**
|
3052
|
+
#
|
3053
|
+
# @return [Types::StartPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3054
|
+
#
|
3055
|
+
# * {Types::StartPiiEntitiesDetectionJobResponse#job_id #job_id} => String
|
3056
|
+
# * {Types::StartPiiEntitiesDetectionJobResponse#job_status #job_status} => String
|
3057
|
+
#
|
3058
|
+
# @example Request syntax with placeholder values
|
3059
|
+
#
|
3060
|
+
# resp = client.start_pii_entities_detection_job({
|
3061
|
+
# input_data_config: { # required
|
3062
|
+
# s3_uri: "S3Uri", # required
|
3063
|
+
# input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
|
3064
|
+
# },
|
3065
|
+
# output_data_config: { # required
|
3066
|
+
# s3_uri: "S3Uri", # required
|
3067
|
+
# kms_key_id: "KmsKeyId",
|
3068
|
+
# },
|
3069
|
+
# mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
|
3070
|
+
# redaction_config: {
|
3071
|
+
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
|
3072
|
+
# mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
|
3073
|
+
# mask_character: "MaskCharacter",
|
3074
|
+
# },
|
3075
|
+
# data_access_role_arn: "IamRoleArn", # required
|
3076
|
+
# job_name: "JobName",
|
3077
|
+
# language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
|
3078
|
+
# client_request_token: "ClientRequestTokenString",
|
3079
|
+
# })
|
3080
|
+
#
|
3081
|
+
# @example Response structure
|
3082
|
+
#
|
3083
|
+
# resp.job_id #=> String
|
3084
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3085
|
+
#
|
3086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob AWS API Documentation
|
3087
|
+
#
|
3088
|
+
# @overload start_pii_entities_detection_job(params = {})
|
3089
|
+
# @param [Hash] params ({})
|
3090
|
+
def start_pii_entities_detection_job(params = {}, options = {})
|
3091
|
+
req = build_request(:start_pii_entities_detection_job, params)
|
3092
|
+
req.send_request(options)
|
3093
|
+
end
|
3094
|
+
|
2665
3095
|
# Starts an asynchronous sentiment detection job for a collection of
|
2666
3096
|
# documents. use the operation to track the status of a job.
|
2667
3097
|
#
|
@@ -2937,6 +3367,36 @@ module Aws::Comprehend
|
|
2937
3367
|
req.send_request(options)
|
2938
3368
|
end
|
2939
3369
|
|
3370
|
+
# Stops an events detection job in progress.
|
3371
|
+
#
|
3372
|
+
# @option params [required, String] :job_id
|
3373
|
+
# The identifier of the events detection job to stop.
|
3374
|
+
#
|
3375
|
+
# @return [Types::StopEventsDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3376
|
+
#
|
3377
|
+
# * {Types::StopEventsDetectionJobResponse#job_id #job_id} => String
|
3378
|
+
# * {Types::StopEventsDetectionJobResponse#job_status #job_status} => String
|
3379
|
+
#
|
3380
|
+
# @example Request syntax with placeholder values
|
3381
|
+
#
|
3382
|
+
# resp = client.stop_events_detection_job({
|
3383
|
+
# job_id: "JobId", # required
|
3384
|
+
# })
|
3385
|
+
#
|
3386
|
+
# @example Response structure
|
3387
|
+
#
|
3388
|
+
# resp.job_id #=> String
|
3389
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3390
|
+
#
|
3391
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopEventsDetectionJob AWS API Documentation
|
3392
|
+
#
|
3393
|
+
# @overload stop_events_detection_job(params = {})
|
3394
|
+
# @param [Hash] params ({})
|
3395
|
+
def stop_events_detection_job(params = {}, options = {})
|
3396
|
+
req = build_request(:stop_events_detection_job, params)
|
3397
|
+
req.send_request(options)
|
3398
|
+
end
|
3399
|
+
|
2940
3400
|
# Stops a key phrases detection job in progress.
|
2941
3401
|
#
|
2942
3402
|
# If the job state is `IN_PROGRESS` the job is marked for termination
|
@@ -2979,6 +3439,36 @@ module Aws::Comprehend
|
|
2979
3439
|
req.send_request(options)
|
2980
3440
|
end
|
2981
3441
|
|
3442
|
+
# Stops a PII entities detection job in progress.
|
3443
|
+
#
|
3444
|
+
# @option params [required, String] :job_id
|
3445
|
+
# The identifier of the PII entities detection job to stop.
|
3446
|
+
#
|
3447
|
+
# @return [Types::StopPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3448
|
+
#
|
3449
|
+
# * {Types::StopPiiEntitiesDetectionJobResponse#job_id #job_id} => String
|
3450
|
+
# * {Types::StopPiiEntitiesDetectionJobResponse#job_status #job_status} => String
|
3451
|
+
#
|
3452
|
+
# @example Request syntax with placeholder values
|
3453
|
+
#
|
3454
|
+
# resp = client.stop_pii_entities_detection_job({
|
3455
|
+
# job_id: "JobId", # required
|
3456
|
+
# })
|
3457
|
+
#
|
3458
|
+
# @example Response structure
|
3459
|
+
#
|
3460
|
+
# resp.job_id #=> String
|
3461
|
+
# resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
|
3462
|
+
#
|
3463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob AWS API Documentation
|
3464
|
+
#
|
3465
|
+
# @overload stop_pii_entities_detection_job(params = {})
|
3466
|
+
# @param [Hash] params ({})
|
3467
|
+
def stop_pii_entities_detection_job(params = {}, options = {})
|
3468
|
+
req = build_request(:stop_pii_entities_detection_job, params)
|
3469
|
+
req.send_request(options)
|
3470
|
+
end
|
3471
|
+
|
2982
3472
|
# Stops a sentiment detection job in progress.
|
2983
3473
|
#
|
2984
3474
|
# If the job state is `IN_PROGRESS` the job is marked for termination
|
@@ -3190,7 +3680,7 @@ module Aws::Comprehend
|
|
3190
3680
|
params: params,
|
3191
3681
|
config: config)
|
3192
3682
|
context[:gem_name] = 'aws-sdk-comprehend'
|
3193
|
-
context[:gem_version] = '1.
|
3683
|
+
context[:gem_version] = '1.43.0'
|
3194
3684
|
Seahorse::Client::Request.new(handlers, context)
|
3195
3685
|
end
|
3196
3686
|
|