aws-sdk-comprehend 1.36.0 → 1.41.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b5a96e637a00e8c096b774627ff97c5b18e008f265ea93791437e3b2003253f6
4
- data.tar.gz: 54e1fcbd10082d304cb8b82f1b9b663e71aa84318433381e9940f409cab73aa3
3
+ metadata.gz: 24f31fc5bb68d1772ccba57fde3cb6eb99a4b49a1feebad85aeb011dad56aa3d
4
+ data.tar.gz: 0bfb9786c8ebd656a2e2744611ede09db5901c8d00142be3f1d34cf7d1b7a7ec
5
5
  SHA512:
6
- metadata.gz: e714952d13b2f7703b4e991300d219e473b6510352731fe360acf4eb6c4a62e428061113316880ab79ad7fe025f70944a344d97e2019c934fbf64c80fa9a7e08
7
- data.tar.gz: 8e70c728cb40bc9e4725e9efd5aaf93d5f989a8a0cd576d010f235ff78761308f10e5d8c36efc8625b8998c0cee2ab2bbadcf22b6e6f3d9512adf78eecce64e1
6
+ metadata.gz: a5cee0708d1fb34fbbdff913199c8835753db4b287d60922015473241b6ec5920d8353ed42673b20faec179ea7a32adf4a2bcca06b1caaa2e6f2a9686fd60b48
7
+ data.tar.gz: 2d4ad92700330564094c5407fdefa253d3612b139041873b3ffba545fe56c534516a474b2609012dc30f9cd1fc5b7dfed6f1a1cad8a4897ece4931db48f0e9ef
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-comprehend/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::Comprehend
49
50
 
50
- GEM_VERSION = '1.36.0'
51
+ GEM_VERSION = '1.41.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::Comprehend
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Comprehend
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -691,8 +706,15 @@ module Aws::Comprehend
691
706
  # },
692
707
  # ],
693
708
  # input_data_config: { # required
694
- # s3_uri: "S3Uri", # required
709
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
710
+ # s3_uri: "S3Uri",
695
711
  # label_delimiter: "LabelDelimiter",
712
+ # augmented_manifests: [
713
+ # {
714
+ # s3_uri: "S3Uri", # required
715
+ # attribute_names: ["AttributeNamesListItem"], # required
716
+ # },
717
+ # ],
696
718
  # },
697
719
  # output_data_config: {
698
720
  # s3_uri: "S3Uri",
@@ -858,12 +880,13 @@ module Aws::Comprehend
858
880
  # },
859
881
  # ],
860
882
  # input_data_config: { # required
883
+ # data_format: "COMPREHEND_CSV", # accepts COMPREHEND_CSV, AUGMENTED_MANIFEST
861
884
  # entity_types: [ # required
862
885
  # {
863
886
  # type: "EntityTypeName", # required
864
887
  # },
865
888
  # ],
866
- # documents: { # required
889
+ # documents: {
867
890
  # s3_uri: "S3Uri", # required
868
891
  # },
869
892
  # annotations: {
@@ -872,6 +895,12 @@ module Aws::Comprehend
872
895
  # entity_list: {
873
896
  # s3_uri: "S3Uri", # required
874
897
  # },
898
+ # augmented_manifests: [
899
+ # {
900
+ # s3_uri: "S3Uri", # required
901
+ # attribute_names: ["AttributeNamesListItem"], # required
902
+ # },
903
+ # ],
875
904
  # },
876
905
  # client_request_token: "ClientRequestTokenString",
877
906
  # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
@@ -1054,8 +1083,13 @@ module Aws::Comprehend
1054
1083
  # resp.document_classifier_properties.end_time #=> Time
1055
1084
  # resp.document_classifier_properties.training_start_time #=> Time
1056
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"
1057
1087
  # resp.document_classifier_properties.input_data_config.s3_uri #=> String
1058
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
1059
1093
  # resp.document_classifier_properties.output_data_config.s3_uri #=> String
1060
1094
  # resp.document_classifier_properties.output_data_config.kms_key_id #=> String
1061
1095
  # resp.document_classifier_properties.classifier_metadata.number_of_labels #=> Integer
@@ -1241,11 +1275,16 @@ module Aws::Comprehend
1241
1275
  # resp.entity_recognizer_properties.end_time #=> Time
1242
1276
  # resp.entity_recognizer_properties.training_start_time #=> Time
1243
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"
1244
1279
  # resp.entity_recognizer_properties.input_data_config.entity_types #=> Array
1245
1280
  # resp.entity_recognizer_properties.input_data_config.entity_types[0].type #=> String
1246
1281
  # resp.entity_recognizer_properties.input_data_config.documents.s3_uri #=> String
1247
1282
  # resp.entity_recognizer_properties.input_data_config.annotations.s3_uri #=> String
1248
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
1249
1288
  # resp.entity_recognizer_properties.recognizer_metadata.number_of_trained_documents #=> Integer
1250
1289
  # resp.entity_recognizer_properties.recognizer_metadata.number_of_test_documents #=> Integer
1251
1290
  # resp.entity_recognizer_properties.recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -1319,6 +1358,52 @@ module Aws::Comprehend
1319
1358
  req.send_request(options)
1320
1359
  end
1321
1360
 
1361
+ # Gets the properties associated with a PII entities detection job. For
1362
+ # example, you can use this operation to get the job status.
1363
+ #
1364
+ # @option params [required, String] :job_id
1365
+ # The identifier that Amazon Comprehend generated for the job. The
1366
+ # operation returns this identifier in its response.
1367
+ #
1368
+ # @return [Types::DescribePiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1369
+ #
1370
+ # * {Types::DescribePiiEntitiesDetectionJobResponse#pii_entities_detection_job_properties #pii_entities_detection_job_properties} => Types::PiiEntitiesDetectionJobProperties
1371
+ #
1372
+ # @example Request syntax with placeholder values
1373
+ #
1374
+ # resp = client.describe_pii_entities_detection_job({
1375
+ # job_id: "JobId", # required
1376
+ # })
1377
+ #
1378
+ # @example Response structure
1379
+ #
1380
+ # resp.pii_entities_detection_job_properties.job_id #=> String
1381
+ # resp.pii_entities_detection_job_properties.job_name #=> String
1382
+ # resp.pii_entities_detection_job_properties.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
1383
+ # resp.pii_entities_detection_job_properties.message #=> String
1384
+ # resp.pii_entities_detection_job_properties.submit_time #=> Time
1385
+ # resp.pii_entities_detection_job_properties.end_time #=> Time
1386
+ # resp.pii_entities_detection_job_properties.input_data_config.s3_uri #=> String
1387
+ # resp.pii_entities_detection_job_properties.input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
1388
+ # resp.pii_entities_detection_job_properties.output_data_config.s3_uri #=> String
1389
+ # resp.pii_entities_detection_job_properties.output_data_config.kms_key_id #=> String
1390
+ # resp.pii_entities_detection_job_properties.redaction_config.pii_entity_types #=> Array
1391
+ # 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"
1392
+ # resp.pii_entities_detection_job_properties.redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
1393
+ # resp.pii_entities_detection_job_properties.redaction_config.mask_character #=> String
1394
+ # resp.pii_entities_detection_job_properties.language_code #=> String, one of "en", "es", "fr", "de", "it", "pt", "ar", "hi", "ja", "ko", "zh", "zh-TW"
1395
+ # resp.pii_entities_detection_job_properties.data_access_role_arn #=> String
1396
+ # resp.pii_entities_detection_job_properties.mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
1397
+ #
1398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob AWS API Documentation
1399
+ #
1400
+ # @overload describe_pii_entities_detection_job(params = {})
1401
+ # @param [Hash] params ({})
1402
+ def describe_pii_entities_detection_job(params = {}, options = {})
1403
+ req = build_request(:describe_pii_entities_detection_job, params)
1404
+ req.send_request(options)
1405
+ end
1406
+
1322
1407
  # Gets the properties associated with a sentiment detection job. Use
1323
1408
  # this operation to get the status of a detection job.
1324
1409
  #
@@ -1542,6 +1627,44 @@ module Aws::Comprehend
1542
1627
  req.send_request(options)
1543
1628
  end
1544
1629
 
1630
+ # Inspects the input text for entities that contain personally
1631
+ # identifiable information (PII) and returns information about them.
1632
+ #
1633
+ # @option params [required, String] :text
1634
+ # A UTF-8 text string. Each string must contain fewer that 5,000 bytes
1635
+ # of UTF-8 encoded characters.
1636
+ #
1637
+ # @option params [required, String] :language_code
1638
+ # The language of the input documents.
1639
+ #
1640
+ # @return [Types::DetectPiiEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1641
+ #
1642
+ # * {Types::DetectPiiEntitiesResponse#entities #entities} => Array<Types::PiiEntity>
1643
+ #
1644
+ # @example Request syntax with placeholder values
1645
+ #
1646
+ # resp = client.detect_pii_entities({
1647
+ # text: "String", # required
1648
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
1649
+ # })
1650
+ #
1651
+ # @example Response structure
1652
+ #
1653
+ # resp.entities #=> Array
1654
+ # resp.entities[0].score #=> Float
1655
+ # 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"
1656
+ # resp.entities[0].begin_offset #=> Integer
1657
+ # resp.entities[0].end_offset #=> Integer
1658
+ #
1659
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities AWS API Documentation
1660
+ #
1661
+ # @overload detect_pii_entities(params = {})
1662
+ # @param [Hash] params ({})
1663
+ def detect_pii_entities(params = {}, options = {})
1664
+ req = build_request(:detect_pii_entities, params)
1665
+ req.send_request(options)
1666
+ end
1667
+
1545
1668
  # Inspects text and returns an inference of the prevailing sentiment
1546
1669
  # (`POSITIVE`, `NEUTRAL`, `MIXED`, or `NEGATIVE`).
1547
1670
  #
@@ -1736,8 +1859,13 @@ module Aws::Comprehend
1736
1859
  # resp.document_classifier_properties_list[0].end_time #=> Time
1737
1860
  # resp.document_classifier_properties_list[0].training_start_time #=> Time
1738
1861
  # resp.document_classifier_properties_list[0].training_end_time #=> Time
1862
+ # resp.document_classifier_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
1739
1863
  # resp.document_classifier_properties_list[0].input_data_config.s3_uri #=> String
1740
1864
  # resp.document_classifier_properties_list[0].input_data_config.label_delimiter #=> String
1865
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests #=> Array
1866
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
1867
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
1868
+ # resp.document_classifier_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
1741
1869
  # resp.document_classifier_properties_list[0].output_data_config.s3_uri #=> String
1742
1870
  # resp.document_classifier_properties_list[0].output_data_config.kms_key_id #=> String
1743
1871
  # resp.document_classifier_properties_list[0].classifier_metadata.number_of_labels #=> Integer
@@ -2005,11 +2133,16 @@ module Aws::Comprehend
2005
2133
  # resp.entity_recognizer_properties_list[0].end_time #=> Time
2006
2134
  # resp.entity_recognizer_properties_list[0].training_start_time #=> Time
2007
2135
  # resp.entity_recognizer_properties_list[0].training_end_time #=> Time
2136
+ # resp.entity_recognizer_properties_list[0].input_data_config.data_format #=> String, one of "COMPREHEND_CSV", "AUGMENTED_MANIFEST"
2008
2137
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_types #=> Array
2009
2138
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_types[0].type #=> String
2010
2139
  # resp.entity_recognizer_properties_list[0].input_data_config.documents.s3_uri #=> String
2011
2140
  # resp.entity_recognizer_properties_list[0].input_data_config.annotations.s3_uri #=> String
2012
2141
  # resp.entity_recognizer_properties_list[0].input_data_config.entity_list.s3_uri #=> String
2142
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests #=> Array
2143
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].s3_uri #=> String
2144
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names #=> Array
2145
+ # resp.entity_recognizer_properties_list[0].input_data_config.augmented_manifests[0].attribute_names[0] #=> String
2013
2146
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_trained_documents #=> Integer
2014
2147
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.number_of_test_documents #=> Integer
2015
2148
  # resp.entity_recognizer_properties_list[0].recognizer_metadata.evaluation_metrics.precision #=> Float
@@ -2103,6 +2236,68 @@ module Aws::Comprehend
2103
2236
  req.send_request(options)
2104
2237
  end
2105
2238
 
2239
+ # Gets a list of the PII entity detection jobs that you have submitted.
2240
+ #
2241
+ # @option params [Types::PiiEntitiesDetectionJobFilter] :filter
2242
+ # Filters the jobs that are returned. You can filter jobs on their name,
2243
+ # status, or the date and time that they were submitted. You can only
2244
+ # set one filter at a time.
2245
+ #
2246
+ # @option params [String] :next_token
2247
+ # Identifies the next page of results to return.
2248
+ #
2249
+ # @option params [Integer] :max_results
2250
+ # The maximum number of results to return in each page.
2251
+ #
2252
+ # @return [Types::ListPiiEntitiesDetectionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2253
+ #
2254
+ # * {Types::ListPiiEntitiesDetectionJobsResponse#pii_entities_detection_job_properties_list #pii_entities_detection_job_properties_list} => Array<Types::PiiEntitiesDetectionJobProperties>
2255
+ # * {Types::ListPiiEntitiesDetectionJobsResponse#next_token #next_token} => String
2256
+ #
2257
+ # @example Request syntax with placeholder values
2258
+ #
2259
+ # resp = client.list_pii_entities_detection_jobs({
2260
+ # filter: {
2261
+ # job_name: "JobName",
2262
+ # job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, FAILED, STOP_REQUESTED, STOPPED
2263
+ # submit_time_before: Time.now,
2264
+ # submit_time_after: Time.now,
2265
+ # },
2266
+ # next_token: "String",
2267
+ # max_results: 1,
2268
+ # })
2269
+ #
2270
+ # @example Response structure
2271
+ #
2272
+ # resp.pii_entities_detection_job_properties_list #=> Array
2273
+ # resp.pii_entities_detection_job_properties_list[0].job_id #=> String
2274
+ # resp.pii_entities_detection_job_properties_list[0].job_name #=> String
2275
+ # resp.pii_entities_detection_job_properties_list[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
2276
+ # resp.pii_entities_detection_job_properties_list[0].message #=> String
2277
+ # resp.pii_entities_detection_job_properties_list[0].submit_time #=> Time
2278
+ # resp.pii_entities_detection_job_properties_list[0].end_time #=> Time
2279
+ # resp.pii_entities_detection_job_properties_list[0].input_data_config.s3_uri #=> String
2280
+ # resp.pii_entities_detection_job_properties_list[0].input_data_config.input_format #=> String, one of "ONE_DOC_PER_FILE", "ONE_DOC_PER_LINE"
2281
+ # resp.pii_entities_detection_job_properties_list[0].output_data_config.s3_uri #=> String
2282
+ # resp.pii_entities_detection_job_properties_list[0].output_data_config.kms_key_id #=> String
2283
+ # resp.pii_entities_detection_job_properties_list[0].redaction_config.pii_entity_types #=> Array
2284
+ # 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"
2285
+ # resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_mode #=> String, one of "MASK", "REPLACE_WITH_PII_ENTITY_TYPE"
2286
+ # resp.pii_entities_detection_job_properties_list[0].redaction_config.mask_character #=> String
2287
+ # 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"
2288
+ # resp.pii_entities_detection_job_properties_list[0].data_access_role_arn #=> String
2289
+ # resp.pii_entities_detection_job_properties_list[0].mode #=> String, one of "ONLY_REDACTION", "ONLY_OFFSETS"
2290
+ # resp.next_token #=> String
2291
+ #
2292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs AWS API Documentation
2293
+ #
2294
+ # @overload list_pii_entities_detection_jobs(params = {})
2295
+ # @param [Hash] params ({})
2296
+ def list_pii_entities_detection_jobs(params = {}, options = {})
2297
+ req = build_request(:list_pii_entities_detection_jobs, params)
2298
+ req.send_request(options)
2299
+ end
2300
+
2106
2301
  # Gets a list of sentiment detection jobs that you have submitted.
2107
2302
  #
2108
2303
  # @option params [Types::SentimentDetectionJobFilter] :filter
@@ -2647,6 +2842,87 @@ module Aws::Comprehend
2647
2842
  req.send_request(options)
2648
2843
  end
2649
2844
 
2845
+ # Starts an asynchronous PII entity detection job for a collection of
2846
+ # documents.
2847
+ #
2848
+ # @option params [required, Types::InputDataConfig] :input_data_config
2849
+ # The input properties for a PII entities detection job.
2850
+ #
2851
+ # @option params [required, Types::OutputDataConfig] :output_data_config
2852
+ # Provides configuration parameters for the output of PII entity
2853
+ # detection jobs.
2854
+ #
2855
+ # @option params [required, String] :mode
2856
+ # Specifies whether the output provides the locations (offsets) of PII
2857
+ # entities or a file in which PII entities are redacted.
2858
+ #
2859
+ # @option params [Types::RedactionConfig] :redaction_config
2860
+ # Provides configuration parameters for PII entity redaction.
2861
+ #
2862
+ # This parameter is required if you set the `Mode` parameter to
2863
+ # `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig`
2864
+ # definition that includes the `PiiEntityTypes` parameter.
2865
+ #
2866
+ # @option params [required, String] :data_access_role_arn
2867
+ # The Amazon Resource Name (ARN) of the AWS Identity and Access
2868
+ # Management (IAM) role that grants Amazon Comprehend read access to
2869
+ # your input data.
2870
+ #
2871
+ # @option params [String] :job_name
2872
+ # The identifier of the job.
2873
+ #
2874
+ # @option params [required, String] :language_code
2875
+ # The language of the input documents.
2876
+ #
2877
+ # @option params [String] :client_request_token
2878
+ # A unique identifier for the request. If you don't set the client
2879
+ # request token, Amazon Comprehend generates one.
2880
+ #
2881
+ # **A suitable default value is auto-generated.** You should normally
2882
+ # not need to pass this option.**
2883
+ #
2884
+ # @return [Types::StartPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2885
+ #
2886
+ # * {Types::StartPiiEntitiesDetectionJobResponse#job_id #job_id} => String
2887
+ # * {Types::StartPiiEntitiesDetectionJobResponse#job_status #job_status} => String
2888
+ #
2889
+ # @example Request syntax with placeholder values
2890
+ #
2891
+ # resp = client.start_pii_entities_detection_job({
2892
+ # input_data_config: { # required
2893
+ # s3_uri: "S3Uri", # required
2894
+ # input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE
2895
+ # },
2896
+ # output_data_config: { # required
2897
+ # s3_uri: "S3Uri", # required
2898
+ # kms_key_id: "KmsKeyId",
2899
+ # },
2900
+ # mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS
2901
+ # redaction_config: {
2902
+ # 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
2903
+ # mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
2904
+ # mask_character: "MaskCharacter",
2905
+ # },
2906
+ # data_access_role_arn: "IamRoleArn", # required
2907
+ # job_name: "JobName",
2908
+ # language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
2909
+ # client_request_token: "ClientRequestTokenString",
2910
+ # })
2911
+ #
2912
+ # @example Response structure
2913
+ #
2914
+ # resp.job_id #=> String
2915
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
2916
+ #
2917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob AWS API Documentation
2918
+ #
2919
+ # @overload start_pii_entities_detection_job(params = {})
2920
+ # @param [Hash] params ({})
2921
+ def start_pii_entities_detection_job(params = {}, options = {})
2922
+ req = build_request(:start_pii_entities_detection_job, params)
2923
+ req.send_request(options)
2924
+ end
2925
+
2650
2926
  # Starts an asynchronous sentiment detection job for a collection of
2651
2927
  # documents. use the operation to track the status of a job.
2652
2928
  #
@@ -2964,6 +3240,36 @@ module Aws::Comprehend
2964
3240
  req.send_request(options)
2965
3241
  end
2966
3242
 
3243
+ # Stops a PII entities detection job in progress.
3244
+ #
3245
+ # @option params [required, String] :job_id
3246
+ # The identifier of the PII entities detection job to stop.
3247
+ #
3248
+ # @return [Types::StopPiiEntitiesDetectionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3249
+ #
3250
+ # * {Types::StopPiiEntitiesDetectionJobResponse#job_id #job_id} => String
3251
+ # * {Types::StopPiiEntitiesDetectionJobResponse#job_status #job_status} => String
3252
+ #
3253
+ # @example Request syntax with placeholder values
3254
+ #
3255
+ # resp = client.stop_pii_entities_detection_job({
3256
+ # job_id: "JobId", # required
3257
+ # })
3258
+ #
3259
+ # @example Response structure
3260
+ #
3261
+ # resp.job_id #=> String
3262
+ # resp.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOP_REQUESTED", "STOPPED"
3263
+ #
3264
+ # @see http://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob AWS API Documentation
3265
+ #
3266
+ # @overload stop_pii_entities_detection_job(params = {})
3267
+ # @param [Hash] params ({})
3268
+ def stop_pii_entities_detection_job(params = {}, options = {})
3269
+ req = build_request(:stop_pii_entities_detection_job, params)
3270
+ req.send_request(options)
3271
+ end
3272
+
2967
3273
  # Stops a sentiment detection job in progress.
2968
3274
  #
2969
3275
  # If the job state is `IN_PROGRESS` the job is marked for termination
@@ -3175,7 +3481,7 @@ module Aws::Comprehend
3175
3481
  params: params,
3176
3482
  config: config)
3177
3483
  context[:gem_name] = 'aws-sdk-comprehend'
3178
- context[:gem_version] = '1.36.0'
3484
+ context[:gem_version] = '1.41.0'
3179
3485
  Seahorse::Client::Request.new(handlers, context)
3180
3486
  end
3181
3487