aws-sdk-macie2 1.44.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-macie2/client.rb +479 -25
- data/lib/aws-sdk-macie2/client_api.rb +276 -0
- data/lib/aws-sdk-macie2/errors.rb +16 -0
- data/lib/aws-sdk-macie2/types.rb +675 -51
- data/lib/aws-sdk-macie2/waiters.rb +121 -0
- data/lib/aws-sdk-macie2.rb +2 -1
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8df284a3b860f522a6cf30162ea116c6de3dabeb05da3ac7307646d3a1f2a9cc
|
4
|
+
data.tar.gz: c295ed59840153e2743c8d1a7d3d6f1928912721bbd0b960b1200c3fd476f40d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4f3ba214231641fe3ecbc05bcc4ebf61154dfe297caf50f81f1f73d0028dc1d10129df6e682d0a9bfeff1066350e8224b49581d9d3cba7eca259208c556fca5c
|
7
|
+
data.tar.gz: 6f254895a42c8426cf8b6525cd30a9d37926f940609bf2a3b360fb78c0089bc72113325a035d81b144f47850c058226a050c871d5f634b89be004dcc07a33544
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.47.0 (2022-08-30)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release of the Amazon Macie API adds support for using allow lists to define specific text and text patterns to ignore when inspecting data sources for sensitive data.
|
8
|
+
|
9
|
+
1.46.0 (2022-07-26)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for retrieving (revealing) sample occurrences of sensitive data that Amazon Macie detects and reports in findings.
|
13
|
+
|
14
|
+
1.45.0 (2022-04-20)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Sensitive data findings in Amazon Macie now indicate how Macie found the sensitive data that produced a finding (originType).
|
18
|
+
|
4
19
|
1.44.0 (2022-02-24)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
@@ -415,8 +415,66 @@ module Aws::Macie2
|
|
415
415
|
req.send_request(options)
|
416
416
|
end
|
417
417
|
|
418
|
+
# Creates and defines the settings for an allow list.
|
419
|
+
#
|
420
|
+
# @option params [required, String] :client_token
|
421
|
+
# **A suitable default value is auto-generated.** You should normally
|
422
|
+
# not need to pass this option.**
|
423
|
+
#
|
424
|
+
# @option params [required, Types::AllowListCriteria] :criteria
|
425
|
+
# Specifies the criteria for an allow list. The criteria must specify a
|
426
|
+
# regular expression (regex) or an S3 object (s3WordsList). It can't
|
427
|
+
# specify both.
|
428
|
+
#
|
429
|
+
# @option params [String] :description
|
430
|
+
#
|
431
|
+
# @option params [required, String] :name
|
432
|
+
#
|
433
|
+
# @option params [Hash<String,String>] :tags
|
434
|
+
# A string-to-string map of key-value pairs that specifies the tags
|
435
|
+
# (keys and values) for an Amazon Macie resource.
|
436
|
+
#
|
437
|
+
# @return [Types::CreateAllowListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
438
|
+
#
|
439
|
+
# * {Types::CreateAllowListResponse#arn #arn} => String
|
440
|
+
# * {Types::CreateAllowListResponse#id #id} => String
|
441
|
+
#
|
442
|
+
# @example Request syntax with placeholder values
|
443
|
+
#
|
444
|
+
# resp = client.create_allow_list({
|
445
|
+
# client_token: "__string", # required
|
446
|
+
# criteria: { # required
|
447
|
+
# regex: "__stringMin1Max512PatternSS",
|
448
|
+
# s3_words_list: {
|
449
|
+
# bucket_name: "__stringMin3Max255PatternAZaZ093255", # required
|
450
|
+
# object_key: "__stringMin1Max1024PatternSS", # required
|
451
|
+
# },
|
452
|
+
# },
|
453
|
+
# description: "__stringMin1Max512PatternSS",
|
454
|
+
# name: "__stringMin1Max128Pattern", # required
|
455
|
+
# tags: {
|
456
|
+
# "__string" => "__string",
|
457
|
+
# },
|
458
|
+
# })
|
459
|
+
#
|
460
|
+
# @example Response structure
|
461
|
+
#
|
462
|
+
# resp.arn #=> String
|
463
|
+
# resp.id #=> String
|
464
|
+
#
|
465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/CreateAllowList AWS API Documentation
|
466
|
+
#
|
467
|
+
# @overload create_allow_list(params = {})
|
468
|
+
# @param [Hash] params ({})
|
469
|
+
def create_allow_list(params = {}, options = {})
|
470
|
+
req = build_request(:create_allow_list, params)
|
471
|
+
req.send_request(options)
|
472
|
+
end
|
473
|
+
|
418
474
|
# Creates and defines the settings for a classification job.
|
419
475
|
#
|
476
|
+
# @option params [Array<String>] :allow_list_ids
|
477
|
+
#
|
420
478
|
# @option params [required, String] :client_token
|
421
479
|
# **A suitable default value is auto-generated.** You should normally
|
422
480
|
# not need to pass this option.**
|
@@ -454,8 +512,7 @@ module Aws::Macie2
|
|
454
512
|
#
|
455
513
|
# @option params [Hash<String,String>] :tags
|
456
514
|
# A string-to-string map of key-value pairs that specifies the tags
|
457
|
-
# (keys and values) for
|
458
|
-
# findings filter, or member account.
|
515
|
+
# (keys and values) for an Amazon Macie resource.
|
459
516
|
#
|
460
517
|
# @return [Types::CreateClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
461
518
|
#
|
@@ -465,6 +522,7 @@ module Aws::Macie2
|
|
465
522
|
# @example Request syntax with placeholder values
|
466
523
|
#
|
467
524
|
# resp = client.create_classification_job({
|
525
|
+
# allow_list_ids: ["__string"],
|
468
526
|
# client_token: "__string", # required
|
469
527
|
# custom_data_identifier_ids: ["__string"],
|
470
528
|
# description: "__string",
|
@@ -636,8 +694,7 @@ module Aws::Macie2
|
|
636
694
|
#
|
637
695
|
# @option params [Hash<String,String>] :tags
|
638
696
|
# A string-to-string map of key-value pairs that specifies the tags
|
639
|
-
# (keys and values) for
|
640
|
-
# findings filter, or member account.
|
697
|
+
# (keys and values) for an Amazon Macie resource.
|
641
698
|
#
|
642
699
|
# @return [Types::CreateCustomDataIdentifierResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
643
700
|
#
|
@@ -701,8 +758,7 @@ module Aws::Macie2
|
|
701
758
|
#
|
702
759
|
# @option params [Hash<String,String>] :tags
|
703
760
|
# A string-to-string map of key-value pairs that specifies the tags
|
704
|
-
# (keys and values) for
|
705
|
-
# findings filter, or member account.
|
761
|
+
# (keys and values) for an Amazon Macie resource.
|
706
762
|
#
|
707
763
|
# @return [Types::CreateFindingsFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
708
764
|
#
|
@@ -793,8 +849,7 @@ module Aws::Macie2
|
|
793
849
|
#
|
794
850
|
# @option params [Hash<String,String>] :tags
|
795
851
|
# A string-to-string map of key-value pairs that specifies the tags
|
796
|
-
# (keys and values) for
|
797
|
-
# findings filter, or member account.
|
852
|
+
# (keys and values) for an Amazon Macie resource.
|
798
853
|
#
|
799
854
|
# @return [Types::CreateMemberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
800
855
|
#
|
@@ -877,6 +932,30 @@ module Aws::Macie2
|
|
877
932
|
req.send_request(options)
|
878
933
|
end
|
879
934
|
|
935
|
+
# Deletes an allow list.
|
936
|
+
#
|
937
|
+
# @option params [required, String] :id
|
938
|
+
#
|
939
|
+
# @option params [String] :ignore_job_checks
|
940
|
+
#
|
941
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
942
|
+
#
|
943
|
+
# @example Request syntax with placeholder values
|
944
|
+
#
|
945
|
+
# resp = client.delete_allow_list({
|
946
|
+
# id: "__string", # required
|
947
|
+
# ignore_job_checks: "__string",
|
948
|
+
# })
|
949
|
+
#
|
950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/DeleteAllowList AWS API Documentation
|
951
|
+
#
|
952
|
+
# @overload delete_allow_list(params = {})
|
953
|
+
# @param [Hash] params ({})
|
954
|
+
def delete_allow_list(params = {}, options = {})
|
955
|
+
req = build_request(:delete_allow_list, params)
|
956
|
+
req.send_request(options)
|
957
|
+
end
|
958
|
+
|
880
959
|
# Soft deletes a custom data identifier.
|
881
960
|
#
|
882
961
|
# @option params [required, String] :id
|
@@ -1089,6 +1168,7 @@ module Aws::Macie2
|
|
1089
1168
|
#
|
1090
1169
|
# @return [Types::DescribeClassificationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1091
1170
|
#
|
1171
|
+
# * {Types::DescribeClassificationJobResponse#allow_list_ids #allow_list_ids} => Array<String>
|
1092
1172
|
# * {Types::DescribeClassificationJobResponse#client_token #client_token} => String
|
1093
1173
|
# * {Types::DescribeClassificationJobResponse#created_at #created_at} => Time
|
1094
1174
|
# * {Types::DescribeClassificationJobResponse#custom_data_identifier_ids #custom_data_identifier_ids} => Array<String>
|
@@ -1118,6 +1198,8 @@ module Aws::Macie2
|
|
1118
1198
|
#
|
1119
1199
|
# @example Response structure
|
1120
1200
|
#
|
1201
|
+
# resp.allow_list_ids #=> Array
|
1202
|
+
# resp.allow_list_ids[0] #=> String
|
1121
1203
|
# resp.client_token #=> String
|
1122
1204
|
# resp.created_at #=> Time
|
1123
1205
|
# resp.custom_data_identifier_ids #=> Array
|
@@ -1319,9 +1401,9 @@ module Aws::Macie2
|
|
1319
1401
|
# @option params [String] :finding_publishing_frequency
|
1320
1402
|
# The frequency with which Amazon Macie publishes updates to policy
|
1321
1403
|
# findings for an account. This includes publishing updates to Security
|
1322
|
-
# Hub and Amazon EventBridge (formerly
|
1323
|
-
#
|
1324
|
-
#
|
1404
|
+
# Hub and Amazon EventBridge (formerly Amazon CloudWatch Events). For
|
1405
|
+
# more information, see [Monitoring and processing findings][1] in the
|
1406
|
+
# *Amazon Macie User Guide*. Valid values are:
|
1325
1407
|
#
|
1326
1408
|
#
|
1327
1409
|
#
|
@@ -1399,6 +1481,53 @@ module Aws::Macie2
|
|
1399
1481
|
req.send_request(options)
|
1400
1482
|
end
|
1401
1483
|
|
1484
|
+
# Retrieves the settings and status of an allow list.
|
1485
|
+
#
|
1486
|
+
# @option params [required, String] :id
|
1487
|
+
#
|
1488
|
+
# @return [Types::GetAllowListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1489
|
+
#
|
1490
|
+
# * {Types::GetAllowListResponse#arn #arn} => String
|
1491
|
+
# * {Types::GetAllowListResponse#created_at #created_at} => Time
|
1492
|
+
# * {Types::GetAllowListResponse#criteria #criteria} => Types::AllowListCriteria
|
1493
|
+
# * {Types::GetAllowListResponse#description #description} => String
|
1494
|
+
# * {Types::GetAllowListResponse#id #id} => String
|
1495
|
+
# * {Types::GetAllowListResponse#name #name} => String
|
1496
|
+
# * {Types::GetAllowListResponse#status #status} => Types::AllowListStatus
|
1497
|
+
# * {Types::GetAllowListResponse#tags #tags} => Hash<String,String>
|
1498
|
+
# * {Types::GetAllowListResponse#updated_at #updated_at} => Time
|
1499
|
+
#
|
1500
|
+
# @example Request syntax with placeholder values
|
1501
|
+
#
|
1502
|
+
# resp = client.get_allow_list({
|
1503
|
+
# id: "__string", # required
|
1504
|
+
# })
|
1505
|
+
#
|
1506
|
+
# @example Response structure
|
1507
|
+
#
|
1508
|
+
# resp.arn #=> String
|
1509
|
+
# resp.created_at #=> Time
|
1510
|
+
# resp.criteria.regex #=> String
|
1511
|
+
# resp.criteria.s3_words_list.bucket_name #=> String
|
1512
|
+
# resp.criteria.s3_words_list.object_key #=> String
|
1513
|
+
# resp.description #=> String
|
1514
|
+
# resp.id #=> String
|
1515
|
+
# resp.name #=> String
|
1516
|
+
# resp.status.code #=> String, one of "OK", "S3_OBJECT_NOT_FOUND", "S3_USER_ACCESS_DENIED", "S3_OBJECT_ACCESS_DENIED", "S3_THROTTLED", "S3_OBJECT_OVERSIZE", "S3_OBJECT_EMPTY", "UNKNOWN_ERROR"
|
1517
|
+
# resp.status.description #=> String
|
1518
|
+
# resp.tags #=> Hash
|
1519
|
+
# resp.tags["__string"] #=> String
|
1520
|
+
# resp.updated_at #=> Time
|
1521
|
+
#
|
1522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetAllowList AWS API Documentation
|
1523
|
+
#
|
1524
|
+
# @overload get_allow_list(params = {})
|
1525
|
+
# @param [Hash] params ({})
|
1526
|
+
def get_allow_list(params = {}, options = {})
|
1527
|
+
req = build_request(:get_allow_list, params)
|
1528
|
+
req.send_request(options)
|
1529
|
+
end
|
1530
|
+
|
1402
1531
|
# Retrieves (queries) aggregated statistical data about S3 buckets that
|
1403
1532
|
# Amazon Macie monitors and analyzes.
|
1404
1533
|
#
|
@@ -1630,6 +1759,7 @@ module Aws::Macie2
|
|
1630
1759
|
# resp.findings[0].classification_details.detailed_results_location #=> String
|
1631
1760
|
# resp.findings[0].classification_details.job_arn #=> String
|
1632
1761
|
# resp.findings[0].classification_details.job_id #=> String
|
1762
|
+
# resp.findings[0].classification_details.origin_type #=> String, one of "SENSITIVE_DATA_DISCOVERY_JOB"
|
1633
1763
|
# resp.findings[0].classification_details.result.additional_occurrences #=> Boolean
|
1634
1764
|
# resp.findings[0].classification_details.result.custom_data_identifiers.detections #=> Array
|
1635
1765
|
# resp.findings[0].classification_details.result.custom_data_identifiers.detections[0].arn #=> String
|
@@ -1997,6 +2127,96 @@ module Aws::Macie2
|
|
1997
2127
|
req.send_request(options)
|
1998
2128
|
end
|
1999
2129
|
|
2130
|
+
# Retrieves the status and configuration settings for retrieving
|
2131
|
+
# occurrences of sensitive data reported by findings.
|
2132
|
+
#
|
2133
|
+
# @return [Types::GetRevealConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2134
|
+
#
|
2135
|
+
# * {Types::GetRevealConfigurationResponse#configuration #configuration} => Types::RevealConfiguration
|
2136
|
+
#
|
2137
|
+
# @example Response structure
|
2138
|
+
#
|
2139
|
+
# resp.configuration.kms_key_id #=> String
|
2140
|
+
# resp.configuration.status #=> String, one of "ENABLED", "DISABLED"
|
2141
|
+
#
|
2142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetRevealConfiguration AWS API Documentation
|
2143
|
+
#
|
2144
|
+
# @overload get_reveal_configuration(params = {})
|
2145
|
+
# @param [Hash] params ({})
|
2146
|
+
def get_reveal_configuration(params = {}, options = {})
|
2147
|
+
req = build_request(:get_reveal_configuration, params)
|
2148
|
+
req.send_request(options)
|
2149
|
+
end
|
2150
|
+
|
2151
|
+
# Retrieves occurrences of sensitive data reported by a finding.
|
2152
|
+
#
|
2153
|
+
# @option params [required, String] :finding_id
|
2154
|
+
#
|
2155
|
+
# @return [Types::GetSensitiveDataOccurrencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2156
|
+
#
|
2157
|
+
# * {Types::GetSensitiveDataOccurrencesResponse#error #error} => String
|
2158
|
+
# * {Types::GetSensitiveDataOccurrencesResponse#sensitive_data_occurrences #sensitive_data_occurrences} => Hash<String,Array<Types::DetectedDataDetails>>
|
2159
|
+
# * {Types::GetSensitiveDataOccurrencesResponse#status #status} => String
|
2160
|
+
#
|
2161
|
+
# @example Request syntax with placeholder values
|
2162
|
+
#
|
2163
|
+
# resp = client.get_sensitive_data_occurrences({
|
2164
|
+
# finding_id: "__string", # required
|
2165
|
+
# })
|
2166
|
+
#
|
2167
|
+
# @example Response structure
|
2168
|
+
#
|
2169
|
+
# resp.error #=> String
|
2170
|
+
# resp.sensitive_data_occurrences #=> Hash
|
2171
|
+
# resp.sensitive_data_occurrences["__string"] #=> Array
|
2172
|
+
# resp.sensitive_data_occurrences["__string"][0].value #=> String
|
2173
|
+
# resp.status #=> String, one of "SUCCESS", "PROCESSING", "ERROR"
|
2174
|
+
#
|
2175
|
+
#
|
2176
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2177
|
+
#
|
2178
|
+
# * finding_revealed
|
2179
|
+
#
|
2180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetSensitiveDataOccurrences AWS API Documentation
|
2181
|
+
#
|
2182
|
+
# @overload get_sensitive_data_occurrences(params = {})
|
2183
|
+
# @param [Hash] params ({})
|
2184
|
+
def get_sensitive_data_occurrences(params = {}, options = {})
|
2185
|
+
req = build_request(:get_sensitive_data_occurrences, params)
|
2186
|
+
req.send_request(options)
|
2187
|
+
end
|
2188
|
+
|
2189
|
+
# Checks whether occurrences of sensitive data can be retrieved for a
|
2190
|
+
# finding.
|
2191
|
+
#
|
2192
|
+
# @option params [required, String] :finding_id
|
2193
|
+
#
|
2194
|
+
# @return [Types::GetSensitiveDataOccurrencesAvailabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2195
|
+
#
|
2196
|
+
# * {Types::GetSensitiveDataOccurrencesAvailabilityResponse#code #code} => String
|
2197
|
+
# * {Types::GetSensitiveDataOccurrencesAvailabilityResponse#reasons #reasons} => Array<String>
|
2198
|
+
#
|
2199
|
+
# @example Request syntax with placeholder values
|
2200
|
+
#
|
2201
|
+
# resp = client.get_sensitive_data_occurrences_availability({
|
2202
|
+
# finding_id: "__string", # required
|
2203
|
+
# })
|
2204
|
+
#
|
2205
|
+
# @example Response structure
|
2206
|
+
#
|
2207
|
+
# resp.code #=> String, one of "AVAILABLE", "UNAVAILABLE"
|
2208
|
+
# resp.reasons #=> Array
|
2209
|
+
# resp.reasons[0] #=> String, one of "OBJECT_EXCEEDS_SIZE_QUOTA", "UNSUPPORTED_OBJECT_TYPE", "UNSUPPORTED_FINDING_TYPE", "INVALID_CLASSIFICATION_RESULT", "OBJECT_UNAVAILABLE"
|
2210
|
+
#
|
2211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/GetSensitiveDataOccurrencesAvailability AWS API Documentation
|
2212
|
+
#
|
2213
|
+
# @overload get_sensitive_data_occurrences_availability(params = {})
|
2214
|
+
# @param [Hash] params ({})
|
2215
|
+
def get_sensitive_data_occurrences_availability(params = {}, options = {})
|
2216
|
+
req = build_request(:get_sensitive_data_occurrences_availability, params)
|
2217
|
+
req.send_request(options)
|
2218
|
+
end
|
2219
|
+
|
2000
2220
|
# Retrieves (queries) quotas and aggregated usage data for one or more
|
2001
2221
|
# accounts.
|
2002
2222
|
#
|
@@ -2097,6 +2317,45 @@ module Aws::Macie2
|
|
2097
2317
|
req.send_request(options)
|
2098
2318
|
end
|
2099
2319
|
|
2320
|
+
# Retrieves a subset of information about all the allow lists for an
|
2321
|
+
# account.
|
2322
|
+
#
|
2323
|
+
# @option params [Integer] :max_results
|
2324
|
+
#
|
2325
|
+
# @option params [String] :next_token
|
2326
|
+
#
|
2327
|
+
# @return [Types::ListAllowListsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2328
|
+
#
|
2329
|
+
# * {Types::ListAllowListsResponse#allow_lists #allow_lists} => Array<Types::AllowListSummary>
|
2330
|
+
# * {Types::ListAllowListsResponse#next_token #next_token} => String
|
2331
|
+
#
|
2332
|
+
# @example Request syntax with placeholder values
|
2333
|
+
#
|
2334
|
+
# resp = client.list_allow_lists({
|
2335
|
+
# max_results: 1,
|
2336
|
+
# next_token: "__string",
|
2337
|
+
# })
|
2338
|
+
#
|
2339
|
+
# @example Response structure
|
2340
|
+
#
|
2341
|
+
# resp.allow_lists #=> Array
|
2342
|
+
# resp.allow_lists[0].arn #=> String
|
2343
|
+
# resp.allow_lists[0].created_at #=> Time
|
2344
|
+
# resp.allow_lists[0].description #=> String
|
2345
|
+
# resp.allow_lists[0].id #=> String
|
2346
|
+
# resp.allow_lists[0].name #=> String
|
2347
|
+
# resp.allow_lists[0].updated_at #=> Time
|
2348
|
+
# resp.next_token #=> String
|
2349
|
+
#
|
2350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/ListAllowLists AWS API Documentation
|
2351
|
+
#
|
2352
|
+
# @overload list_allow_lists(params = {})
|
2353
|
+
# @param [Hash] params ({})
|
2354
|
+
def list_allow_lists(params = {}, options = {})
|
2355
|
+
req = build_request(:list_allow_lists, params)
|
2356
|
+
req.send_request(options)
|
2357
|
+
end
|
2358
|
+
|
2100
2359
|
# Retrieves a subset of information about one or more classification
|
2101
2360
|
# jobs.
|
2102
2361
|
#
|
@@ -2487,9 +2746,8 @@ module Aws::Macie2
|
|
2487
2746
|
req.send_request(options)
|
2488
2747
|
end
|
2489
2748
|
|
2490
|
-
# Retrieves the tags (keys and values) that are associated with
|
2491
|
-
#
|
2492
|
-
# account.
|
2749
|
+
# Retrieves the tags (keys and values) that are associated with an
|
2750
|
+
# Amazon Macie resource.
|
2493
2751
|
#
|
2494
2752
|
# @option params [required, String] :resource_arn
|
2495
2753
|
#
|
@@ -2710,15 +2968,13 @@ module Aws::Macie2
|
|
2710
2968
|
end
|
2711
2969
|
|
2712
2970
|
# Adds or updates one or more tags (keys and values) that are associated
|
2713
|
-
# with
|
2714
|
-
# member account.
|
2971
|
+
# with an Amazon Macie resource.
|
2715
2972
|
#
|
2716
2973
|
# @option params [required, String] :resource_arn
|
2717
2974
|
#
|
2718
2975
|
# @option params [required, Hash<String,String>] :tags
|
2719
2976
|
# A string-to-string map of key-value pairs that specifies the tags
|
2720
|
-
# (keys and values) for
|
2721
|
-
# findings filter, or member account.
|
2977
|
+
# (keys and values) for an Amazon Macie resource.
|
2722
2978
|
#
|
2723
2979
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2724
2980
|
#
|
@@ -2779,8 +3035,8 @@ module Aws::Macie2
|
|
2779
3035
|
req.send_request(options)
|
2780
3036
|
end
|
2781
3037
|
|
2782
|
-
# Removes one or more tags (keys and values) from
|
2783
|
-
#
|
3038
|
+
# Removes one or more tags (keys and values) from an Amazon Macie
|
3039
|
+
# resource.
|
2784
3040
|
#
|
2785
3041
|
# @option params [required, String] :resource_arn
|
2786
3042
|
#
|
@@ -2804,6 +3060,53 @@ module Aws::Macie2
|
|
2804
3060
|
req.send_request(options)
|
2805
3061
|
end
|
2806
3062
|
|
3063
|
+
# Updates the settings for an allow list.
|
3064
|
+
#
|
3065
|
+
# @option params [required, Types::AllowListCriteria] :criteria
|
3066
|
+
# Specifies the criteria for an allow list. The criteria must specify a
|
3067
|
+
# regular expression (regex) or an S3 object (s3WordsList). It can't
|
3068
|
+
# specify both.
|
3069
|
+
#
|
3070
|
+
# @option params [String] :description
|
3071
|
+
#
|
3072
|
+
# @option params [required, String] :id
|
3073
|
+
#
|
3074
|
+
# @option params [required, String] :name
|
3075
|
+
#
|
3076
|
+
# @return [Types::UpdateAllowListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3077
|
+
#
|
3078
|
+
# * {Types::UpdateAllowListResponse#arn #arn} => String
|
3079
|
+
# * {Types::UpdateAllowListResponse#id #id} => String
|
3080
|
+
#
|
3081
|
+
# @example Request syntax with placeholder values
|
3082
|
+
#
|
3083
|
+
# resp = client.update_allow_list({
|
3084
|
+
# criteria: { # required
|
3085
|
+
# regex: "__stringMin1Max512PatternSS",
|
3086
|
+
# s3_words_list: {
|
3087
|
+
# bucket_name: "__stringMin3Max255PatternAZaZ093255", # required
|
3088
|
+
# object_key: "__stringMin1Max1024PatternSS", # required
|
3089
|
+
# },
|
3090
|
+
# },
|
3091
|
+
# description: "__stringMin1Max512PatternSS",
|
3092
|
+
# id: "__string", # required
|
3093
|
+
# name: "__stringMin1Max128Pattern", # required
|
3094
|
+
# })
|
3095
|
+
#
|
3096
|
+
# @example Response structure
|
3097
|
+
#
|
3098
|
+
# resp.arn #=> String
|
3099
|
+
# resp.id #=> String
|
3100
|
+
#
|
3101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/UpdateAllowList AWS API Documentation
|
3102
|
+
#
|
3103
|
+
# @overload update_allow_list(params = {})
|
3104
|
+
# @param [Hash] params ({})
|
3105
|
+
def update_allow_list(params = {}, options = {})
|
3106
|
+
req = build_request(:update_allow_list, params)
|
3107
|
+
req.send_request(options)
|
3108
|
+
end
|
3109
|
+
|
2807
3110
|
# Changes the status of a classification job.
|
2808
3111
|
#
|
2809
3112
|
# @option params [required, String] :job_id
|
@@ -2901,9 +3204,9 @@ module Aws::Macie2
|
|
2901
3204
|
# @option params [String] :finding_publishing_frequency
|
2902
3205
|
# The frequency with which Amazon Macie publishes updates to policy
|
2903
3206
|
# findings for an account. This includes publishing updates to Security
|
2904
|
-
# Hub and Amazon EventBridge (formerly
|
2905
|
-
#
|
2906
|
-
#
|
3207
|
+
# Hub and Amazon EventBridge (formerly Amazon CloudWatch Events). For
|
3208
|
+
# more information, see [Monitoring and processing findings][1] in the
|
3209
|
+
# *Amazon Macie User Guide*. Valid values are:
|
2907
3210
|
#
|
2908
3211
|
#
|
2909
3212
|
#
|
@@ -2978,6 +3281,44 @@ module Aws::Macie2
|
|
2978
3281
|
req.send_request(options)
|
2979
3282
|
end
|
2980
3283
|
|
3284
|
+
# Updates the status and configuration settings for retrieving
|
3285
|
+
# occurrences of sensitive data reported by findings.
|
3286
|
+
#
|
3287
|
+
# @option params [required, Types::RevealConfiguration] :configuration
|
3288
|
+
# Specifies the configuration settings for retrieving occurrences of
|
3289
|
+
# sensitive data reported by findings, and the status of the
|
3290
|
+
# configuration for an Amazon Macie account. When you enable the
|
3291
|
+
# configuration for the first time, your request must specify an Key
|
3292
|
+
# Management Service (KMS) key. Otherwise, an error occurs. Macie uses
|
3293
|
+
# the specified key to encrypt the sensitive data that you retrieve.
|
3294
|
+
#
|
3295
|
+
# @return [Types::UpdateRevealConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3296
|
+
#
|
3297
|
+
# * {Types::UpdateRevealConfigurationResponse#configuration #configuration} => Types::RevealConfiguration
|
3298
|
+
#
|
3299
|
+
# @example Request syntax with placeholder values
|
3300
|
+
#
|
3301
|
+
# resp = client.update_reveal_configuration({
|
3302
|
+
# configuration: { # required
|
3303
|
+
# kms_key_id: "__stringMin1Max2048",
|
3304
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
3305
|
+
# },
|
3306
|
+
# })
|
3307
|
+
#
|
3308
|
+
# @example Response structure
|
3309
|
+
#
|
3310
|
+
# resp.configuration.kms_key_id #=> String
|
3311
|
+
# resp.configuration.status #=> String, one of "ENABLED", "DISABLED"
|
3312
|
+
#
|
3313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01/UpdateRevealConfiguration AWS API Documentation
|
3314
|
+
#
|
3315
|
+
# @overload update_reveal_configuration(params = {})
|
3316
|
+
# @param [Hash] params ({})
|
3317
|
+
def update_reveal_configuration(params = {}, options = {})
|
3318
|
+
req = build_request(:update_reveal_configuration, params)
|
3319
|
+
req.send_request(options)
|
3320
|
+
end
|
3321
|
+
|
2981
3322
|
# @!endgroup
|
2982
3323
|
|
2983
3324
|
# @param params ({})
|
@@ -2991,14 +3332,127 @@ module Aws::Macie2
|
|
2991
3332
|
params: params,
|
2992
3333
|
config: config)
|
2993
3334
|
context[:gem_name] = 'aws-sdk-macie2'
|
2994
|
-
context[:gem_version] = '1.
|
3335
|
+
context[:gem_version] = '1.47.0'
|
2995
3336
|
Seahorse::Client::Request.new(handlers, context)
|
2996
3337
|
end
|
2997
3338
|
|
3339
|
+
# Polls an API operation until a resource enters a desired state.
|
3340
|
+
#
|
3341
|
+
# ## Basic Usage
|
3342
|
+
#
|
3343
|
+
# A waiter will call an API operation until:
|
3344
|
+
#
|
3345
|
+
# * It is successful
|
3346
|
+
# * It enters a terminal state
|
3347
|
+
# * It makes the maximum number of attempts
|
3348
|
+
#
|
3349
|
+
# In between attempts, the waiter will sleep.
|
3350
|
+
#
|
3351
|
+
# # polls in a loop, sleeping between attempts
|
3352
|
+
# client.wait_until(waiter_name, params)
|
3353
|
+
#
|
3354
|
+
# ## Configuration
|
3355
|
+
#
|
3356
|
+
# You can configure the maximum number of polling attempts, and the
|
3357
|
+
# delay (in seconds) between each polling attempt. You can pass
|
3358
|
+
# configuration as the final arguments hash.
|
3359
|
+
#
|
3360
|
+
# # poll for ~25 seconds
|
3361
|
+
# client.wait_until(waiter_name, params, {
|
3362
|
+
# max_attempts: 5,
|
3363
|
+
# delay: 5,
|
3364
|
+
# })
|
3365
|
+
#
|
3366
|
+
# ## Callbacks
|
3367
|
+
#
|
3368
|
+
# You can be notified before each polling attempt and before each
|
3369
|
+
# delay. If you throw `:success` or `:failure` from these callbacks,
|
3370
|
+
# it will terminate the waiter.
|
3371
|
+
#
|
3372
|
+
# started_at = Time.now
|
3373
|
+
# client.wait_until(waiter_name, params, {
|
3374
|
+
#
|
3375
|
+
# # disable max attempts
|
3376
|
+
# max_attempts: nil,
|
3377
|
+
#
|
3378
|
+
# # poll for 1 hour, instead of a number of attempts
|
3379
|
+
# before_wait: -> (attempts, response) do
|
3380
|
+
# throw :failure if Time.now - started_at > 3600
|
3381
|
+
# end
|
3382
|
+
# })
|
3383
|
+
#
|
3384
|
+
# ## Handling Errors
|
3385
|
+
#
|
3386
|
+
# When a waiter is unsuccessful, it will raise an error.
|
3387
|
+
# All of the failure errors extend from
|
3388
|
+
# {Aws::Waiters::Errors::WaiterFailed}.
|
3389
|
+
#
|
3390
|
+
# begin
|
3391
|
+
# client.wait_until(...)
|
3392
|
+
# rescue Aws::Waiters::Errors::WaiterFailed
|
3393
|
+
# # resource did not enter the desired state in time
|
3394
|
+
# end
|
3395
|
+
#
|
3396
|
+
# ## Valid Waiters
|
3397
|
+
#
|
3398
|
+
# The following table lists the valid waiter names, the operations they call,
|
3399
|
+
# and the default `:delay` and `:max_attempts` values.
|
3400
|
+
#
|
3401
|
+
# | waiter_name | params | :delay | :max_attempts |
|
3402
|
+
# | ---------------- | --------------------------------------- | -------- | ------------- |
|
3403
|
+
# | finding_revealed | {Client#get_sensitive_data_occurrences} | 2 | 60 |
|
3404
|
+
#
|
3405
|
+
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
3406
|
+
# because the waiter has entered a state that it will not transition
|
3407
|
+
# out of, preventing success.
|
3408
|
+
#
|
3409
|
+
# @raise [Errors::TooManyAttemptsError] Raised when the configured
|
3410
|
+
# maximum number of attempts have been made, and the waiter is not
|
3411
|
+
# yet successful.
|
3412
|
+
#
|
3413
|
+
# @raise [Errors::UnexpectedError] Raised when an error is encounted
|
3414
|
+
# while polling for a resource that is not expected.
|
3415
|
+
#
|
3416
|
+
# @raise [Errors::NoSuchWaiterError] Raised when you request to wait
|
3417
|
+
# for an unknown state.
|
3418
|
+
#
|
3419
|
+
# @return [Boolean] Returns `true` if the waiter was successful.
|
3420
|
+
# @param [Symbol] waiter_name
|
3421
|
+
# @param [Hash] params ({})
|
3422
|
+
# @param [Hash] options ({})
|
3423
|
+
# @option options [Integer] :max_attempts
|
3424
|
+
# @option options [Integer] :delay
|
3425
|
+
# @option options [Proc] :before_attempt
|
3426
|
+
# @option options [Proc] :before_wait
|
3427
|
+
def wait_until(waiter_name, params = {}, options = {})
|
3428
|
+
w = waiter(waiter_name, options)
|
3429
|
+
yield(w.waiter) if block_given? # deprecated
|
3430
|
+
w.wait(params)
|
3431
|
+
end
|
3432
|
+
|
2998
3433
|
# @api private
|
2999
3434
|
# @deprecated
|
3000
3435
|
def waiter_names
|
3001
|
-
|
3436
|
+
waiters.keys
|
3437
|
+
end
|
3438
|
+
|
3439
|
+
private
|
3440
|
+
|
3441
|
+
# @param [Symbol] waiter_name
|
3442
|
+
# @param [Hash] options ({})
|
3443
|
+
def waiter(waiter_name, options = {})
|
3444
|
+
waiter_class = waiters[waiter_name]
|
3445
|
+
if waiter_class
|
3446
|
+
waiter_class.new(options.merge(client: self))
|
3447
|
+
else
|
3448
|
+
raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
|
3449
|
+
end
|
3450
|
+
end
|
3451
|
+
|
3452
|
+
def waiters
|
3453
|
+
{
|
3454
|
+
finding_revealed: Waiters::FindingRevealed
|
3455
|
+
}
|
3002
3456
|
end
|
3003
3457
|
|
3004
3458
|
class << self
|