aws-sdk-auditmanager 1.27.0 → 1.28.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-auditmanager/client.rb +135 -29
- data/lib/aws-sdk-auditmanager/client_api.rb +15 -0
- data/lib/aws-sdk-auditmanager/types.rb +174 -19
- data/lib/aws-sdk-auditmanager.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 14c9a2bbba11aa4991946da8d6a60d605977a49c1b5a66e6dd8cfe1bd4d497c4
|
4
|
+
data.tar.gz: 0135c251504249a65941fa1b72f2305b699860d26777f731a96d8ef2459aa797
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1f3240882caa2165a12ad980d32aac132cebb882785a6a86b7bc355050a7d912363d96cef586d2e6f6ac35fe26a1490c4edf7d2f7acc6e47b164f7581156c5e1
|
7
|
+
data.tar.gz: d0db54b1830a2f41a9f80a29780a2033d8c1c620ffea16ee120579090bb2fa40c7680207ff00cdbae12b142a52228a0867844bbc14b9f162d57f742081df590c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.28.0 (2022-11-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release introduces a new feature for Audit Manager: Evidence finder. You can now use evidence finder to quickly query your evidence, and add the matching evidence results to an assessment report.
|
8
|
+
|
4
9
|
1.27.0 (2022-10-25)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.28.0
|
@@ -575,7 +575,33 @@ module Aws::AuditManager
|
|
575
575
|
end
|
576
576
|
|
577
577
|
# Uploads one or more pieces of evidence to a control in an Audit
|
578
|
-
# Manager assessment.
|
578
|
+
# Manager assessment. You can upload manual evidence from any Amazon
|
579
|
+
# Simple Storage Service (Amazon S3) bucket by specifying the S3 URI of
|
580
|
+
# the evidence.
|
581
|
+
#
|
582
|
+
# You must upload manual evidence to your S3 bucket before you can
|
583
|
+
# upload it to your assessment. For instructions, see [CreateBucket][1]
|
584
|
+
# and [PutObject][2] in the *Amazon Simple Storage Service API
|
585
|
+
# Reference.*
|
586
|
+
#
|
587
|
+
# The following restrictions apply to this action:
|
588
|
+
#
|
589
|
+
# * Maximum size of an individual evidence file: 100 MB
|
590
|
+
#
|
591
|
+
# * Number of daily manual evidence uploads per control: 100
|
592
|
+
#
|
593
|
+
# * Supported file formats: See [Supported file types for manual
|
594
|
+
# evidence][3] in the *Audit Manager User Guide*
|
595
|
+
#
|
596
|
+
# For more information about Audit Manager service restrictions, see
|
597
|
+
# [Quotas and restrictions for Audit Manager][4].
|
598
|
+
#
|
599
|
+
#
|
600
|
+
#
|
601
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
|
602
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
|
603
|
+
# [3]: https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files
|
604
|
+
# [4]: https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html
|
579
605
|
#
|
580
606
|
# @option params [required, String] :assessment_id
|
581
607
|
# The identifier for the assessment.
|
@@ -885,6 +911,30 @@ module Aws::AuditManager
|
|
885
911
|
# @option params [required, String] :assessment_id
|
886
912
|
# The identifier for the assessment.
|
887
913
|
#
|
914
|
+
# @option params [String] :query_statement
|
915
|
+
# A SQL statement that represents an evidence finder query.
|
916
|
+
#
|
917
|
+
# Provide this parameter when you want to generate an assessment report
|
918
|
+
# from the results of an evidence finder search query. When you use this
|
919
|
+
# parameter, Audit Manager generates a one-time report using only the
|
920
|
+
# evidence from the query output. This report does not include any
|
921
|
+
# assessment evidence that was manually [added to a report using the
|
922
|
+
# console][1], or [associated with a report using the API][2].
|
923
|
+
#
|
924
|
+
# To use this parameter, the [enablementStatus][3] of evidence finder
|
925
|
+
# must be `ENABLED`.
|
926
|
+
#
|
927
|
+
# For examples and help resolving `queryStatement` validation
|
928
|
+
# exceptions, see [Troubleshooting evidence finder issues][4] in the AWS
|
929
|
+
# Audit Manager User Guide.
|
930
|
+
#
|
931
|
+
#
|
932
|
+
#
|
933
|
+
# [1]: https://docs.aws.amazon.com/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence
|
934
|
+
# [2]: https://docs.aws.amazon.com/APIReference-evidenceFinder/API_BatchAssociateAssessmentReportEvidence.html
|
935
|
+
# [3]: https://docs.aws.amazon.com/APIReference-evidenceFinder/API_EvidenceFinderSetup.html#auditmanager-Type-EvidenceFinderSetup-enablementStatus
|
936
|
+
# [4]: https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions
|
937
|
+
#
|
888
938
|
# @return [Types::CreateAssessmentReportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
889
939
|
#
|
890
940
|
# * {Types::CreateAssessmentReportResponse#assessment_report #assessment_report} => Types::AssessmentReport
|
@@ -895,6 +945,7 @@ module Aws::AuditManager
|
|
895
945
|
# name: "AssessmentReportName", # required
|
896
946
|
# description: "AssessmentReportDescription",
|
897
947
|
# assessment_id: "UUID", # required
|
948
|
+
# query_statement: "QueryStatement",
|
898
949
|
# })
|
899
950
|
#
|
900
951
|
# @example Response structure
|
@@ -1227,48 +1278,65 @@ module Aws::AuditManager
|
|
1227
1278
|
# Audit Manager will stop collecting and attaching evidence to that
|
1228
1279
|
# delegated administrator account moving forward.
|
1229
1280
|
#
|
1230
|
-
#
|
1281
|
+
# Keep in mind the following cleanup task if you use evidence finder:
|
1282
|
+
#
|
1283
|
+
# Before you use your management account to remove a delegated
|
1284
|
+
# administrator, make sure that the current delegated administrator
|
1285
|
+
# account signs in to Audit Manager and disables evidence finder first.
|
1286
|
+
# Disabling evidence finder automatically deletes the event data store
|
1287
|
+
# that was created in their account when they enabled evidence finder.
|
1288
|
+
# If this task isn’t completed, the event data store remains in their
|
1289
|
+
# account. In this case, we recommend that the original delegated
|
1290
|
+
# administrator goes to CloudTrail Lake and manually [deletes the event
|
1291
|
+
# data store][1].
|
1292
|
+
#
|
1293
|
+
# This cleanup task is necessary to ensure that you don't end up with
|
1294
|
+
# multiple event data stores. Audit Manager will ignore an unused event
|
1295
|
+
# data store after you remove or change a delegated administrator
|
1296
|
+
# account. However, the unused event data store continues to incur
|
1297
|
+
# storage costs from CloudTrail Lake if you don't delete it.
|
1298
|
+
#
|
1299
|
+
# When you deregister a delegated administrator account for Audit
|
1231
1300
|
# Manager, the data for that account isn’t deleted. If you want to
|
1232
1301
|
# delete resource data for a delegated administrator account, you must
|
1233
1302
|
# perform that task separately before you deregister the account.
|
1234
1303
|
# Either, you can do this in the Audit Manager console. Or, you can use
|
1235
1304
|
# one of the delete API operations that are provided by Audit Manager.
|
1236
1305
|
#
|
1237
|
-
#
|
1306
|
+
# To delete your Audit Manager resource data, see the following
|
1238
1307
|
# instructions:
|
1239
1308
|
#
|
1240
|
-
#
|
1309
|
+
# * [DeleteAssessment][2] (see also: [Deleting an assessment][3] in the
|
1241
1310
|
# *Audit Manager User Guide*)
|
1242
1311
|
#
|
1243
|
-
# * [DeleteAssessmentFramework][
|
1244
|
-
# framework][
|
1312
|
+
# * [DeleteAssessmentFramework][4] (see also: [Deleting a custom
|
1313
|
+
# framework][5] in the *Audit Manager User Guide*)
|
1245
1314
|
#
|
1246
|
-
# * [DeleteAssessmentFrameworkShare][
|
1247
|
-
# request][
|
1315
|
+
# * [DeleteAssessmentFrameworkShare][6] (see also: [Deleting a share
|
1316
|
+
# request][7] in the *Audit Manager User Guide*)
|
1248
1317
|
#
|
1249
|
-
# * [DeleteAssessmentReport][
|
1250
|
-
# report][
|
1318
|
+
# * [DeleteAssessmentReport][8] (see also: [Deleting an assessment
|
1319
|
+
# report][9] in the *Audit Manager User Guide*)
|
1251
1320
|
#
|
1252
|
-
# * [DeleteControl][
|
1253
|
-
# *Audit Manager User Guide*)
|
1321
|
+
# * [DeleteControl][10] (see also: [Deleting a custom control][11] in
|
1322
|
+
# the *Audit Manager User Guide*)
|
1254
1323
|
#
|
1255
|
-
#
|
1324
|
+
# At this time, Audit Manager doesn't provide an option to delete
|
1256
1325
|
# evidence. All available delete operations are listed above.
|
1257
1326
|
#
|
1258
|
-
# </note>
|
1259
1327
|
#
|
1260
1328
|
#
|
1261
|
-
#
|
1262
|
-
# [
|
1263
|
-
# [
|
1264
|
-
# [
|
1265
|
-
# [
|
1266
|
-
# [
|
1267
|
-
# [
|
1268
|
-
# [
|
1269
|
-
# [
|
1270
|
-
# [
|
1271
|
-
# [
|
1329
|
+
# [1]: https://docs.aws.amazon.com/userguide/awscloudtrail/latest/userguide/query-eds-disable-termination.html
|
1330
|
+
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessment.html
|
1331
|
+
# [3]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-assessment.html
|
1332
|
+
# [4]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFramework.html
|
1333
|
+
# [5]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-custom-framework.html
|
1334
|
+
# [6]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentFrameworkShare.html
|
1335
|
+
# [7]: https://docs.aws.amazon.com/audit-manager/latest/userguide/deleting-shared-framework-requests.html
|
1336
|
+
# [8]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteAssessmentReport.html
|
1337
|
+
# [9]: https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#delete-assessment-report-steps
|
1338
|
+
# [10]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeleteControl.html
|
1339
|
+
# [11]: https://docs.aws.amazon.com/audit-manager/latest/userguide/delete-controls.html
|
1272
1340
|
#
|
1273
1341
|
# @option params [String] :admin_account_id
|
1274
1342
|
# The identifier for the administrator account.
|
@@ -1734,6 +1802,7 @@ module Aws::AuditManager
|
|
1734
1802
|
# resp.evidence.resources_included #=> Array
|
1735
1803
|
# resp.evidence.resources_included[0].arn #=> String
|
1736
1804
|
# resp.evidence.resources_included[0].value #=> String
|
1805
|
+
# resp.evidence.resources_included[0].compliance_check #=> String
|
1737
1806
|
# resp.evidence.attributes #=> Hash
|
1738
1807
|
# resp.evidence.attributes["EvidenceAttributeKey"] #=> String
|
1739
1808
|
# resp.evidence.iam_id #=> String
|
@@ -1801,6 +1870,7 @@ module Aws::AuditManager
|
|
1801
1870
|
# resp.evidence[0].resources_included #=> Array
|
1802
1871
|
# resp.evidence[0].resources_included[0].arn #=> String
|
1803
1872
|
# resp.evidence[0].resources_included[0].value #=> String
|
1873
|
+
# resp.evidence[0].resources_included[0].compliance_check #=> String
|
1804
1874
|
# resp.evidence[0].attributes #=> Hash
|
1805
1875
|
# resp.evidence[0].attributes["EvidenceAttributeKey"] #=> String
|
1806
1876
|
# resp.evidence[0].iam_id #=> String
|
@@ -2084,8 +2154,15 @@ module Aws::AuditManager
|
|
2084
2154
|
req.send_request(options)
|
2085
2155
|
end
|
2086
2156
|
|
2087
|
-
# Returns a list of the
|
2088
|
-
# assessment.
|
2157
|
+
# Returns a list of all of the Amazon Web Services that you can choose
|
2158
|
+
# to include in your assessment. When you [create an assessment][1],
|
2159
|
+
# specify which of these services you want to include to narrow the
|
2160
|
+
# assessment's [scope][2].
|
2161
|
+
#
|
2162
|
+
#
|
2163
|
+
#
|
2164
|
+
# [1]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html
|
2165
|
+
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html
|
2089
2166
|
#
|
2090
2167
|
# @return [Types::GetServicesInScopeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2091
2168
|
#
|
@@ -2120,7 +2197,7 @@ module Aws::AuditManager
|
|
2120
2197
|
# @example Request syntax with placeholder values
|
2121
2198
|
#
|
2122
2199
|
# resp = client.get_settings({
|
2123
|
-
# attribute: "ALL", # required, accepts ALL, IS_AWS_ORG_ENABLED, SNS_TOPIC, DEFAULT_ASSESSMENT_REPORTS_DESTINATION, DEFAULT_PROCESS_OWNERS
|
2200
|
+
# attribute: "ALL", # required, accepts ALL, IS_AWS_ORG_ENABLED, SNS_TOPIC, DEFAULT_ASSESSMENT_REPORTS_DESTINATION, DEFAULT_PROCESS_OWNERS, EVIDENCE_FINDER_ENABLEMENT
|
2124
2201
|
# })
|
2125
2202
|
#
|
2126
2203
|
# @example Response structure
|
@@ -2133,6 +2210,10 @@ module Aws::AuditManager
|
|
2133
2210
|
# resp.settings.default_process_owners[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
|
2134
2211
|
# resp.settings.default_process_owners[0].role_arn #=> String
|
2135
2212
|
# resp.settings.kms_key #=> String
|
2213
|
+
# resp.settings.evidence_finder_enablement.event_data_store_arn #=> String
|
2214
|
+
# resp.settings.evidence_finder_enablement.enablement_status #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS"
|
2215
|
+
# resp.settings.evidence_finder_enablement.backfill_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
|
2216
|
+
# resp.settings.evidence_finder_enablement.error #=> String
|
2136
2217
|
#
|
2137
2218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetSettings AWS API Documentation
|
2138
2219
|
#
|
@@ -3603,6 +3684,26 @@ module Aws::AuditManager
|
|
3603
3684
|
# @option params [String] :kms_key
|
3604
3685
|
# The KMS key details.
|
3605
3686
|
#
|
3687
|
+
# @option params [Boolean] :evidence_finder_enabled
|
3688
|
+
# Specifies whether the evidence finder feature is enabled. Change this
|
3689
|
+
# attribute to enable or disable evidence finder.
|
3690
|
+
#
|
3691
|
+
# When you use this attribute to disable evidence finder, Audit Manager
|
3692
|
+
# deletes the event data store that’s used to query your evidence data.
|
3693
|
+
# As a result, you can’t re-enable evidence finder and use the feature
|
3694
|
+
# again. Your only alternative is to [deregister][1] and then
|
3695
|
+
# [re-register][2] Audit Manager.
|
3696
|
+
#
|
3697
|
+
# Disabling evidence finder is permanent, so consider this decision
|
3698
|
+
# carefully before you proceed. If you’re using Audit Manager as a
|
3699
|
+
# delegated administrator, keep in mind that this action applies to all
|
3700
|
+
# member accounts in your organization.
|
3701
|
+
#
|
3702
|
+
#
|
3703
|
+
#
|
3704
|
+
# [1]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html
|
3705
|
+
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html
|
3706
|
+
#
|
3606
3707
|
# @return [Types::UpdateSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3607
3708
|
#
|
3608
3709
|
# * {Types::UpdateSettingsResponse#settings #settings} => Types::Settings
|
@@ -3622,6 +3723,7 @@ module Aws::AuditManager
|
|
3622
3723
|
# },
|
3623
3724
|
# ],
|
3624
3725
|
# kms_key: "KmsKey",
|
3726
|
+
# evidence_finder_enabled: false,
|
3625
3727
|
# })
|
3626
3728
|
#
|
3627
3729
|
# @example Response structure
|
@@ -3634,6 +3736,10 @@ module Aws::AuditManager
|
|
3634
3736
|
# resp.settings.default_process_owners[0].role_type #=> String, one of "PROCESS_OWNER", "RESOURCE_OWNER"
|
3635
3737
|
# resp.settings.default_process_owners[0].role_arn #=> String
|
3636
3738
|
# resp.settings.kms_key #=> String
|
3739
|
+
# resp.settings.evidence_finder_enablement.event_data_store_arn #=> String
|
3740
|
+
# resp.settings.evidence_finder_enablement.enablement_status #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS"
|
3741
|
+
# resp.settings.evidence_finder_enablement.backfill_status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "COMPLETED"
|
3742
|
+
# resp.settings.evidence_finder_enablement.error #=> String
|
3637
3743
|
#
|
3638
3744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings AWS API Documentation
|
3639
3745
|
#
|
@@ -3695,7 +3801,7 @@ module Aws::AuditManager
|
|
3695
3801
|
params: params,
|
3696
3802
|
config: config)
|
3697
3803
|
context[:gem_name] = 'aws-sdk-auditmanager'
|
3698
|
-
context[:gem_version] = '1.
|
3804
|
+
context[:gem_version] = '1.28.0'
|
3699
3805
|
Seahorse::Client::Request.new(handlers, context)
|
3700
3806
|
end
|
3701
3807
|
|
@@ -75,6 +75,7 @@ module Aws::AuditManager
|
|
75
75
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
76
76
|
ChangeLog = Shapes::StructureShape.new(name: 'ChangeLog')
|
77
77
|
ChangeLogs = Shapes::ListShape.new(name: 'ChangeLogs')
|
78
|
+
CloudTrailArn = Shapes::StringShape.new(name: 'CloudTrailArn')
|
78
79
|
ComplianceType = Shapes::StringShape.new(name: 'ComplianceType')
|
79
80
|
Control = Shapes::StructureShape.new(name: 'Control')
|
80
81
|
ControlComment = Shapes::StructureShape.new(name: 'ControlComment')
|
@@ -152,6 +153,9 @@ module Aws::AuditManager
|
|
152
153
|
EvidenceAttributeKey = Shapes::StringShape.new(name: 'EvidenceAttributeKey')
|
153
154
|
EvidenceAttributeValue = Shapes::StringShape.new(name: 'EvidenceAttributeValue')
|
154
155
|
EvidenceAttributes = Shapes::MapShape.new(name: 'EvidenceAttributes')
|
156
|
+
EvidenceFinderBackfillStatus = Shapes::StringShape.new(name: 'EvidenceFinderBackfillStatus')
|
157
|
+
EvidenceFinderEnablement = Shapes::StructureShape.new(name: 'EvidenceFinderEnablement')
|
158
|
+
EvidenceFinderEnablementStatus = Shapes::StringShape.new(name: 'EvidenceFinderEnablementStatus')
|
155
159
|
EvidenceIds = Shapes::ListShape.new(name: 'EvidenceIds')
|
156
160
|
EvidenceInsights = Shapes::StructureShape.new(name: 'EvidenceInsights')
|
157
161
|
EvidenceList = Shapes::ListShape.new(name: 'EvidenceList')
|
@@ -242,6 +246,7 @@ module Aws::AuditManager
|
|
242
246
|
Notifications = Shapes::ListShape.new(name: 'Notifications')
|
243
247
|
NullableInteger = Shapes::IntegerShape.new(name: 'NullableInteger')
|
244
248
|
ObjectTypeEnum = Shapes::StringShape.new(name: 'ObjectTypeEnum')
|
249
|
+
QueryStatement = Shapes::StringShape.new(name: 'QueryStatement')
|
245
250
|
Region = Shapes::StringShape.new(name: 'Region')
|
246
251
|
RegisterAccountRequest = Shapes::StructureShape.new(name: 'RegisterAccountRequest')
|
247
252
|
RegisterAccountResponse = Shapes::StructureShape.new(name: 'RegisterAccountResponse')
|
@@ -668,6 +673,7 @@ module Aws::AuditManager
|
|
668
673
|
CreateAssessmentReportRequest.add_member(:name, Shapes::ShapeRef.new(shape: AssessmentReportName, required: true, location_name: "name"))
|
669
674
|
CreateAssessmentReportRequest.add_member(:description, Shapes::ShapeRef.new(shape: AssessmentReportDescription, location_name: "description"))
|
670
675
|
CreateAssessmentReportRequest.add_member(:assessment_id, Shapes::ShapeRef.new(shape: UUID, required: true, location: "uri", location_name: "assessmentId"))
|
676
|
+
CreateAssessmentReportRequest.add_member(:query_statement, Shapes::ShapeRef.new(shape: QueryStatement, location_name: "queryStatement"))
|
671
677
|
CreateAssessmentReportRequest.struct_class = Types::CreateAssessmentReportRequest
|
672
678
|
|
673
679
|
CreateAssessmentReportResponse.add_member(:assessment_report, Shapes::ShapeRef.new(shape: AssessmentReport, location_name: "assessmentReport"))
|
@@ -807,6 +813,12 @@ module Aws::AuditManager
|
|
807
813
|
EvidenceAttributes.key = Shapes::ShapeRef.new(shape: EvidenceAttributeKey)
|
808
814
|
EvidenceAttributes.value = Shapes::ShapeRef.new(shape: EvidenceAttributeValue)
|
809
815
|
|
816
|
+
EvidenceFinderEnablement.add_member(:event_data_store_arn, Shapes::ShapeRef.new(shape: CloudTrailArn, location_name: "eventDataStoreArn"))
|
817
|
+
EvidenceFinderEnablement.add_member(:enablement_status, Shapes::ShapeRef.new(shape: EvidenceFinderEnablementStatus, location_name: "enablementStatus"))
|
818
|
+
EvidenceFinderEnablement.add_member(:backfill_status, Shapes::ShapeRef.new(shape: EvidenceFinderBackfillStatus, location_name: "backfillStatus"))
|
819
|
+
EvidenceFinderEnablement.add_member(:error, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "error"))
|
820
|
+
EvidenceFinderEnablement.struct_class = Types::EvidenceFinderEnablement
|
821
|
+
|
810
822
|
EvidenceIds.member = Shapes::ShapeRef.new(shape: UUID)
|
811
823
|
|
812
824
|
EvidenceInsights.add_member(:noncompliant_evidence_count, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "noncompliantEvidenceCount"))
|
@@ -1128,6 +1140,7 @@ module Aws::AuditManager
|
|
1128
1140
|
|
1129
1141
|
Resource.add_member(:arn, Shapes::ShapeRef.new(shape: GenericArn, location_name: "arn"))
|
1130
1142
|
Resource.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "value"))
|
1143
|
+
Resource.add_member(:compliance_check, Shapes::ShapeRef.new(shape: String, location_name: "complianceCheck"))
|
1131
1144
|
Resource.struct_class = Types::Resource
|
1132
1145
|
|
1133
1146
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
|
@@ -1163,6 +1176,7 @@ module Aws::AuditManager
|
|
1163
1176
|
Settings.add_member(:default_assessment_reports_destination, Shapes::ShapeRef.new(shape: AssessmentReportsDestination, location_name: "defaultAssessmentReportsDestination"))
|
1164
1177
|
Settings.add_member(:default_process_owners, Shapes::ShapeRef.new(shape: Roles, location_name: "defaultProcessOwners"))
|
1165
1178
|
Settings.add_member(:kms_key, Shapes::ShapeRef.new(shape: KmsKey, location_name: "kmsKey"))
|
1179
|
+
Settings.add_member(:evidence_finder_enablement, Shapes::ShapeRef.new(shape: EvidenceFinderEnablement, location_name: "evidenceFinderEnablement"))
|
1166
1180
|
Settings.struct_class = Types::Settings
|
1167
1181
|
|
1168
1182
|
SourceKeyword.add_member(:keyword_input_type, Shapes::ShapeRef.new(shape: KeywordInputType, location_name: "keywordInputType"))
|
@@ -1280,6 +1294,7 @@ module Aws::AuditManager
|
|
1280
1294
|
UpdateSettingsRequest.add_member(:default_assessment_reports_destination, Shapes::ShapeRef.new(shape: AssessmentReportsDestination, location_name: "defaultAssessmentReportsDestination"))
|
1281
1295
|
UpdateSettingsRequest.add_member(:default_process_owners, Shapes::ShapeRef.new(shape: Roles, location_name: "defaultProcessOwners"))
|
1282
1296
|
UpdateSettingsRequest.add_member(:kms_key, Shapes::ShapeRef.new(shape: KmsKey, location_name: "kmsKey"))
|
1297
|
+
UpdateSettingsRequest.add_member(:evidence_finder_enabled, Shapes::ShapeRef.new(shape: Boolean, location_name: "evidenceFinderEnabled"))
|
1283
1298
|
UpdateSettingsRequest.struct_class = Types::UpdateSettingsRequest
|
1284
1299
|
|
1285
1300
|
UpdateSettingsResponse.add_member(:settings, Shapes::ShapeRef.new(shape: Settings, location_name: "settings"))
|
@@ -691,19 +691,19 @@ module Aws::AuditManager
|
|
691
691
|
include Aws::Structure
|
692
692
|
end
|
693
693
|
|
694
|
-
# An error entity for
|
695
|
-
#
|
694
|
+
# An error entity for assessment report evidence errors. This is used to
|
695
|
+
# provide more meaningful errors than a simple string message.
|
696
696
|
#
|
697
697
|
# @!attribute [rw] evidence_id
|
698
698
|
# The identifier for the evidence.
|
699
699
|
# @return [String]
|
700
700
|
#
|
701
701
|
# @!attribute [rw] error_code
|
702
|
-
# The error code that
|
702
|
+
# The error code that was returned.
|
703
703
|
# @return [String]
|
704
704
|
#
|
705
705
|
# @!attribute [rw] error_message
|
706
|
-
# The error message that
|
706
|
+
# The error message that was returned.
|
707
707
|
# @return [String]
|
708
708
|
#
|
709
709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/AssessmentReportEvidenceError AWS API Documentation
|
@@ -1224,7 +1224,7 @@ module Aws::AuditManager
|
|
1224
1224
|
# @return [String]
|
1225
1225
|
#
|
1226
1226
|
# @!attribute [rw] control_sources
|
1227
|
-
# The data source that
|
1227
|
+
# The data source types that determine where Audit Manager collects
|
1228
1228
|
# evidence from for the control.
|
1229
1229
|
# @return [String]
|
1230
1230
|
#
|
@@ -1702,6 +1702,7 @@ module Aws::AuditManager
|
|
1702
1702
|
# name: "AssessmentReportName", # required
|
1703
1703
|
# description: "AssessmentReportDescription",
|
1704
1704
|
# assessment_id: "UUID", # required
|
1705
|
+
# query_statement: "QueryStatement",
|
1705
1706
|
# }
|
1706
1707
|
#
|
1707
1708
|
# @!attribute [rw] name
|
@@ -1716,12 +1717,39 @@ module Aws::AuditManager
|
|
1716
1717
|
# The identifier for the assessment.
|
1717
1718
|
# @return [String]
|
1718
1719
|
#
|
1720
|
+
# @!attribute [rw] query_statement
|
1721
|
+
# A SQL statement that represents an evidence finder query.
|
1722
|
+
#
|
1723
|
+
# Provide this parameter when you want to generate an assessment
|
1724
|
+
# report from the results of an evidence finder search query. When you
|
1725
|
+
# use this parameter, Audit Manager generates a one-time report using
|
1726
|
+
# only the evidence from the query output. This report does not
|
1727
|
+
# include any assessment evidence that was manually [added to a report
|
1728
|
+
# using the console][1], or [associated with a report using the
|
1729
|
+
# API][2].
|
1730
|
+
#
|
1731
|
+
# To use this parameter, the [enablementStatus][3] of evidence finder
|
1732
|
+
# must be `ENABLED`.
|
1733
|
+
#
|
1734
|
+
# For examples and help resolving `queryStatement` validation
|
1735
|
+
# exceptions, see [Troubleshooting evidence finder issues][4] in the
|
1736
|
+
# AWS Audit Manager User Guide.
|
1737
|
+
#
|
1738
|
+
#
|
1739
|
+
#
|
1740
|
+
# [1]: https://docs.aws.amazon.com/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence
|
1741
|
+
# [2]: https://docs.aws.amazon.com/APIReference-evidenceFinder/API_BatchAssociateAssessmentReportEvidence.html
|
1742
|
+
# [3]: https://docs.aws.amazon.com/APIReference-evidenceFinder/API_EvidenceFinderSetup.html#auditmanager-Type-EvidenceFinderSetup-enablementStatus
|
1743
|
+
# [4]: https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions
|
1744
|
+
# @return [String]
|
1745
|
+
#
|
1719
1746
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/CreateAssessmentReportRequest AWS API Documentation
|
1720
1747
|
#
|
1721
1748
|
class CreateAssessmentReportRequest < Struct.new(
|
1722
1749
|
:name,
|
1723
1750
|
:description,
|
1724
|
-
:assessment_id
|
1751
|
+
:assessment_id,
|
1752
|
+
:query_statement)
|
1725
1753
|
SENSITIVE = []
|
1726
1754
|
include Aws::Structure
|
1727
1755
|
end
|
@@ -2413,10 +2441,24 @@ module Aws::AuditManager
|
|
2413
2441
|
# @return [String]
|
2414
2442
|
#
|
2415
2443
|
# @!attribute [rw] compliance_check
|
2416
|
-
# The evaluation status for evidence that falls under the
|
2417
|
-
# check category.
|
2418
|
-
#
|
2419
|
-
# *
|
2444
|
+
# The evaluation status for automated evidence that falls under the
|
2445
|
+
# compliance check category.
|
2446
|
+
#
|
2447
|
+
# * Audit Manager classes evidence as non-compliant if Security Hub
|
2448
|
+
# reports a *Fail* result, or if Config reports a *Non-compliant*
|
2449
|
+
# result.
|
2450
|
+
#
|
2451
|
+
# * Audit Manager classes evidence as compliant if Security Hub
|
2452
|
+
# reports a *Pass* result, or if Config reports a *Compliant*
|
2453
|
+
# result.
|
2454
|
+
#
|
2455
|
+
# * If a compliance check isn't available or applicable, then no
|
2456
|
+
# compliance evaluation can be made for that evidence. This is the
|
2457
|
+
# case if the evidence uses Config or Security Hub as the underlying
|
2458
|
+
# data source type, but those services aren't enabled. This is also
|
2459
|
+
# the case if the evidence uses an underlying data source type that
|
2460
|
+
# doesn't support compliance checks (such as manual evidence,
|
2461
|
+
# Amazon Web Services API calls, or CloudTrail).
|
2420
2462
|
# @return [String]
|
2421
2463
|
#
|
2422
2464
|
# @!attribute [rw] aws_organization
|
@@ -2462,6 +2504,73 @@ module Aws::AuditManager
|
|
2462
2504
|
include Aws::Structure
|
2463
2505
|
end
|
2464
2506
|
|
2507
|
+
# The settings object that specifies whether evidence finder is enabled.
|
2508
|
+
# This object also describes the related event data store, and the
|
2509
|
+
# backfill status for populating the event data store with evidence
|
2510
|
+
# data.
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] event_data_store_arn
|
2513
|
+
# The Amazon Resource Name (ARN) of the CloudTrail Lake event data
|
2514
|
+
# store that’s used by evidence finder. The event data store is the
|
2515
|
+
# lake of evidence data that evidence finder runs queries against.
|
2516
|
+
# @return [String]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] enablement_status
|
2519
|
+
# The current status of the evidence finder feature and the related
|
2520
|
+
# event data store.
|
2521
|
+
#
|
2522
|
+
# * `ENABLE_IN_PROGRESS` means that you requested to enable evidence
|
2523
|
+
# finder. An event data store is currently being created to support
|
2524
|
+
# evidence finder queries.
|
2525
|
+
#
|
2526
|
+
# * `ENABLED` means that an event data store was successfully created
|
2527
|
+
# and evidence finder is enabled. We recommend that you wait 24
|
2528
|
+
# hours until the event data store is backfilled with your past
|
2529
|
+
# evidence data. You can use evidence finder in the meantime, but
|
2530
|
+
# not all data might be available until the backfill is complete.
|
2531
|
+
#
|
2532
|
+
# * `DISABLE_IN_PROGRESS` means that you requested to disable evidence
|
2533
|
+
# finder, and your request is pending the deletion of the event data
|
2534
|
+
# store.
|
2535
|
+
#
|
2536
|
+
# * `DISABLED` means that you have permanently disabled evidence
|
2537
|
+
# finder and the event data store has been deleted. You can't
|
2538
|
+
# re-enable evidence finder after this point.
|
2539
|
+
# @return [String]
|
2540
|
+
#
|
2541
|
+
# @!attribute [rw] backfill_status
|
2542
|
+
# The current status of the evidence data backfill process.
|
2543
|
+
#
|
2544
|
+
# The backfill starts after you enable evidence finder. During this
|
2545
|
+
# task, Audit Manager populates an event data store with your past
|
2546
|
+
# evidence data so that your evidence can be queried.
|
2547
|
+
#
|
2548
|
+
# * `NOT_STARTED` means that the backfill hasn’t started yet.
|
2549
|
+
#
|
2550
|
+
# * `IN_PROGRESS` means that the backfill is in progress. This can
|
2551
|
+
# take up to 24 hours to complete, depending on the amount of
|
2552
|
+
# evidence data.
|
2553
|
+
#
|
2554
|
+
# * `COMPLETED` means that the backfill is complete. All of your past
|
2555
|
+
# evidence is now queryable.
|
2556
|
+
# @return [String]
|
2557
|
+
#
|
2558
|
+
# @!attribute [rw] error
|
2559
|
+
# Represents any errors that occurred when enabling or disabling
|
2560
|
+
# evidence finder.
|
2561
|
+
# @return [String]
|
2562
|
+
#
|
2563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/EvidenceFinderEnablement AWS API Documentation
|
2564
|
+
#
|
2565
|
+
class EvidenceFinderEnablement < Struct.new(
|
2566
|
+
:event_data_store_arn,
|
2567
|
+
:enablement_status,
|
2568
|
+
:backfill_status,
|
2569
|
+
:error)
|
2570
|
+
SENSITIVE = []
|
2571
|
+
include Aws::Structure
|
2572
|
+
end
|
2573
|
+
|
2465
2574
|
# A breakdown of the latest compliance check status for the evidence in
|
2466
2575
|
# your Audit Manager assessments.
|
2467
2576
|
#
|
@@ -3240,7 +3349,7 @@ module Aws::AuditManager
|
|
3240
3349
|
# data as a hash:
|
3241
3350
|
#
|
3242
3351
|
# {
|
3243
|
-
# attribute: "ALL", # required, accepts ALL, IS_AWS_ORG_ENABLED, SNS_TOPIC, DEFAULT_ASSESSMENT_REPORTS_DESTINATION, DEFAULT_PROCESS_OWNERS
|
3352
|
+
# attribute: "ALL", # required, accepts ALL, IS_AWS_ORG_ENABLED, SNS_TOPIC, DEFAULT_ASSESSMENT_REPORTS_DESTINATION, DEFAULT_PROCESS_OWNERS, EVIDENCE_FINDER_ENABLEMENT
|
3244
3353
|
# }
|
3245
3354
|
#
|
3246
3355
|
# @!attribute [rw] attribute
|
@@ -4171,11 +4280,34 @@ module Aws::AuditManager
|
|
4171
4280
|
# The value of the resource.
|
4172
4281
|
# @return [String]
|
4173
4282
|
#
|
4283
|
+
# @!attribute [rw] compliance_check
|
4284
|
+
# The evaluation status for a resource that was assessed when
|
4285
|
+
# collecting compliance check evidence.
|
4286
|
+
#
|
4287
|
+
# * Audit Manager classes the resource as non-compliant if Security
|
4288
|
+
# Hub reports a *Fail* result, or if Config reports a
|
4289
|
+
# *Non-compliant* result.
|
4290
|
+
#
|
4291
|
+
# * Audit Manager classes the resource as compliant if Security Hub
|
4292
|
+
# reports a *Pass* result, or if Config reports a *Compliant*
|
4293
|
+
# result.
|
4294
|
+
#
|
4295
|
+
# * If a compliance check isn't available or applicable, then no
|
4296
|
+
# compliance evaluation can be made for that resource. This is the
|
4297
|
+
# case if a resource assessment uses Config or Security Hub as the
|
4298
|
+
# underlying data source type, but those services aren't enabled.
|
4299
|
+
# This is also the case if the resource assessment uses an
|
4300
|
+
# underlying data source type that doesn't support compliance
|
4301
|
+
# checks (such as manual evidence, Amazon Web Services API calls, or
|
4302
|
+
# CloudTrail).
|
4303
|
+
# @return [String]
|
4304
|
+
#
|
4174
4305
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/Resource AWS API Documentation
|
4175
4306
|
#
|
4176
4307
|
class Resource < Struct.new(
|
4177
4308
|
:arn,
|
4178
|
-
:value
|
4309
|
+
:value,
|
4310
|
+
:compliance_check)
|
4179
4311
|
SENSITIVE = []
|
4180
4312
|
include Aws::Structure
|
4181
4313
|
end
|
@@ -4356,6 +4488,10 @@ module Aws::AuditManager
|
|
4356
4488
|
# The KMS key details.
|
4357
4489
|
# @return [String]
|
4358
4490
|
#
|
4491
|
+
# @!attribute [rw] evidence_finder_enablement
|
4492
|
+
# The current evidence finder status and event data store details.
|
4493
|
+
# @return [Types::EvidenceFinderEnablement]
|
4494
|
+
#
|
4359
4495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/Settings AWS API Documentation
|
4360
4496
|
#
|
4361
4497
|
class Settings < Struct.new(
|
@@ -4363,7 +4499,8 @@ module Aws::AuditManager
|
|
4363
4499
|
:sns_topic,
|
4364
4500
|
:default_assessment_reports_destination,
|
4365
4501
|
:default_process_owners,
|
4366
|
-
:kms_key
|
4502
|
+
:kms_key,
|
4503
|
+
:evidence_finder_enablement)
|
4367
4504
|
SENSITIVE = []
|
4368
4505
|
include Aws::Structure
|
4369
4506
|
end
|
@@ -4437,11 +4574,6 @@ module Aws::AuditManager
|
|
4437
4574
|
# `keywordValue`\: `Custom_CustomRuleForAccount-conformance-pack`
|
4438
4575
|
#
|
4439
4576
|
# * Service-linked rule name:
|
4440
|
-
# securityhub-api-gw-cache-encrypted-101104e1
|
4441
|
-
#
|
4442
|
-
# `keywordValue`\: `Custom_securityhub-api-gw-cache-encrypted`
|
4443
|
-
#
|
4444
|
-
# * Service-linked rule name:
|
4445
4577
|
# OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
|
4446
4578
|
#
|
4447
4579
|
# `keywordValue`\:
|
@@ -5084,6 +5216,7 @@ module Aws::AuditManager
|
|
5084
5216
|
# },
|
5085
5217
|
# ],
|
5086
5218
|
# kms_key: "KmsKey",
|
5219
|
+
# evidence_finder_enabled: false,
|
5087
5220
|
# }
|
5088
5221
|
#
|
5089
5222
|
# @!attribute [rw] sns_topic
|
@@ -5103,13 +5236,35 @@ module Aws::AuditManager
|
|
5103
5236
|
# The KMS key details.
|
5104
5237
|
# @return [String]
|
5105
5238
|
#
|
5239
|
+
# @!attribute [rw] evidence_finder_enabled
|
5240
|
+
# Specifies whether the evidence finder feature is enabled. Change
|
5241
|
+
# this attribute to enable or disable evidence finder.
|
5242
|
+
#
|
5243
|
+
# When you use this attribute to disable evidence finder, Audit
|
5244
|
+
# Manager deletes the event data store that’s used to query your
|
5245
|
+
# evidence data. As a result, you can’t re-enable evidence finder and
|
5246
|
+
# use the feature again. Your only alternative is to [deregister][1]
|
5247
|
+
# and then [re-register][2] Audit Manager.
|
5248
|
+
#
|
5249
|
+
# Disabling evidence finder is permanent, so consider this decision
|
5250
|
+
# carefully before you proceed. If you’re using Audit Manager as a
|
5251
|
+
# delegated administrator, keep in mind that this action applies to
|
5252
|
+
# all member accounts in your organization.
|
5253
|
+
#
|
5254
|
+
#
|
5255
|
+
#
|
5256
|
+
# [1]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_DeregisterAccount.html
|
5257
|
+
# [2]: https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_RegisterAccount.html
|
5258
|
+
# @return [Boolean]
|
5259
|
+
#
|
5106
5260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettingsRequest AWS API Documentation
|
5107
5261
|
#
|
5108
5262
|
class UpdateSettingsRequest < Struct.new(
|
5109
5263
|
:sns_topic,
|
5110
5264
|
:default_assessment_reports_destination,
|
5111
5265
|
:default_process_owners,
|
5112
|
-
:kms_key
|
5266
|
+
:kms_key,
|
5267
|
+
:evidence_finder_enabled)
|
5113
5268
|
SENSITIVE = []
|
5114
5269
|
include Aws::Structure
|
5115
5270
|
end
|
data/lib/aws-sdk-auditmanager.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-auditmanager
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.28.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-11-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|