/
auditmanager.jl
2501 lines (2270 loc) · 80.7 KB
/
auditmanager.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# This file is auto-generated by AWSMetadata.jl
using AWS
using AWS.AWSServices: auditmanager
using AWS.Compat
using AWS.UUIDs
"""
associate_assessment_report_evidence_folder(assessment_id, evidence_folder_id)
associate_assessment_report_evidence_folder(assessment_id, evidence_folder_id, params::Dict{String,<:Any})
Associates an evidence folder to an assessment report in an Audit Manager assessment.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `evidence_folder_id`: The identifier for the folder that the evidence is stored in.
"""
function associate_assessment_report_evidence_folder(
assessmentId, evidenceFolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/associateToAssessmentReport",
Dict{String,Any}("evidenceFolderId" => evidenceFolderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function associate_assessment_report_evidence_folder(
assessmentId,
evidenceFolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/associateToAssessmentReport",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("evidenceFolderId" => evidenceFolderId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_associate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids)
batch_associate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids, params::Dict{String,<:Any})
Associates a list of evidence to an assessment report in an Audit Manager assessment.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `evidence_folder_id`: The identifier for the folder that the evidence is stored in.
- `evidence_ids`: The list of evidence identifiers.
"""
function batch_associate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/batchAssociateToAssessmentReport",
Dict{String,Any}(
"evidenceFolderId" => evidenceFolderId, "evidenceIds" => evidenceIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_associate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/batchAssociateToAssessmentReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"evidenceFolderId" => evidenceFolderId, "evidenceIds" => evidenceIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_create_delegation_by_assessment(assessment_id, create_delegation_requests)
batch_create_delegation_by_assessment(assessment_id, create_delegation_requests, params::Dict{String,<:Any})
Creates a batch of delegations for an assessment in Audit Manager.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `create_delegation_requests`: The API request to batch create delegations in Audit
Manager.
"""
function batch_create_delegation_by_assessment(
assessmentId,
createDelegationRequests;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/delegations",
Dict{String,Any}("createDelegationRequests" => createDelegationRequests);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_create_delegation_by_assessment(
assessmentId,
createDelegationRequests,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/delegations",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("createDelegationRequests" => createDelegationRequests),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_delete_delegation_by_assessment(assessment_id, delegation_ids)
batch_delete_delegation_by_assessment(assessment_id, delegation_ids, params::Dict{String,<:Any})
Deletes a batch of delegations for an assessment in Audit Manager.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `delegation_ids`: The identifiers for the delegations.
"""
function batch_delete_delegation_by_assessment(
assessmentId, delegationIds; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/delegations",
Dict{String,Any}("delegationIds" => delegationIds);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_delete_delegation_by_assessment(
assessmentId,
delegationIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/delegations",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("delegationIds" => delegationIds), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_disassociate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids)
batch_disassociate_assessment_report_evidence(assessment_id, evidence_folder_id, evidence_ids, params::Dict{String,<:Any})
Disassociates a list of evidence from an assessment report in Audit Manager.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `evidence_folder_id`: The identifier for the folder that the evidence is stored in.
- `evidence_ids`: The list of evidence identifiers.
"""
function batch_disassociate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/batchDisassociateFromAssessmentReport",
Dict{String,Any}(
"evidenceFolderId" => evidenceFolderId, "evidenceIds" => evidenceIds
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_disassociate_assessment_report_evidence(
assessmentId,
evidenceFolderId,
evidenceIds,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/batchDisassociateFromAssessmentReport",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"evidenceFolderId" => evidenceFolderId, "evidenceIds" => evidenceIds
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence)
batch_import_evidence_to_assessment_control(assessment_id, control_id, control_set_id, manual_evidence, params::Dict{String,<:Any})
Uploads one or more pieces of evidence to a control in an Audit Manager assessment. You can
upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by
specifying the S3 URI of the evidence. You must upload manual evidence to your S3 bucket
before you can upload it to your assessment. For instructions, see CreateBucket and
PutObject in the Amazon Simple Storage Service API Reference. The following restrictions
apply to this action: Maximum size of an individual evidence file: 100 MB Number of
daily manual evidence uploads per control: 100 Supported file formats: See Supported file
types for manual evidence in the Audit Manager User Guide For more information about
Audit Manager service restrictions, see Quotas and restrictions for Audit Manager.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `control_id`: The identifier for the control.
- `control_set_id`: The identifier for the control set.
- `manual_evidence`: The list of manual evidence objects.
"""
function batch_import_evidence_to_assessment_control(
assessmentId,
controlId,
controlSetId,
manualEvidence;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/controlSets/$(controlSetId)/controls/$(controlId)/evidence",
Dict{String,Any}("manualEvidence" => manualEvidence);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function batch_import_evidence_to_assessment_control(
assessmentId,
controlId,
controlSetId,
manualEvidence,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/controlSets/$(controlSetId)/controls/$(controlId)/evidence",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("manualEvidence" => manualEvidence), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assessment(assessment_reports_destination, framework_id, name, roles, scope)
create_assessment(assessment_reports_destination, framework_id, name, roles, scope, params::Dict{String,<:Any})
Creates an assessment in Audit Manager.
# Arguments
- `assessment_reports_destination`: The assessment report storage destination for the
assessment that's being created.
- `framework_id`: The identifier for the framework that the assessment will be created
from.
- `name`: The name of the assessment to be created.
- `roles`: The list of roles for the assessment.
- `scope`:
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The optional description of the assessment to be created.
- `"tags"`: The tags that are associated with the assessment.
"""
function create_assessment(
assessmentReportsDestination,
frameworkId,
name,
roles,
scope;
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments",
Dict{String,Any}(
"assessmentReportsDestination" => assessmentReportsDestination,
"frameworkId" => frameworkId,
"name" => name,
"roles" => roles,
"scope" => scope,
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assessment(
assessmentReportsDestination,
frameworkId,
name,
roles,
scope,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"assessmentReportsDestination" => assessmentReportsDestination,
"frameworkId" => frameworkId,
"name" => name,
"roles" => roles,
"scope" => scope,
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assessment_framework(control_sets, name)
create_assessment_framework(control_sets, name, params::Dict{String,<:Any})
Creates a custom framework in Audit Manager.
# Arguments
- `control_sets`: The control sets that are associated with the framework.
- `name`: The name of the new custom framework.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"complianceType"`: The compliance type that the new custom framework supports, such as
CIS or HIPAA.
- `"description"`: An optional description for the new custom framework.
- `"tags"`: The tags that are associated with the framework.
"""
function create_assessment_framework(
controlSets, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/assessmentFrameworks",
Dict{String,Any}("controlSets" => controlSets, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assessment_framework(
controlSets,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessmentFrameworks",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}("controlSets" => controlSets, "name" => name),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_assessment_report(assessment_id, name)
create_assessment_report(assessment_id, name, params::Dict{String,<:Any})
Creates an assessment report for the specified assessment.
# Arguments
- `assessment_id`: The identifier for the assessment.
- `name`: The name of the new assessment report.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"description"`: The description of the assessment report.
- `"queryStatement"`: A SQL statement that represents an evidence finder query. Provide
this parameter when you want to generate an assessment report from the results of an
evidence finder search query. When you use this parameter, Audit Manager generates a
one-time report using only the evidence from the query output. This report does not include
any assessment evidence that was manually added to a report using the console, or
associated with a report using the API. To use this parameter, the enablementStatus of
evidence finder must be ENABLED. For examples and help resolving queryStatement
validation exceptions, see Troubleshooting evidence finder issues in the Audit Manager User
Guide.
"""
function create_assessment_report(
assessmentId, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/reports",
Dict{String,Any}("name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_assessment_report(
assessmentId,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/assessments/$(assessmentId)/reports",
Dict{String,Any}(mergewith(_merge, Dict{String,Any}("name" => name), params));
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
create_control(control_mapping_sources, name)
create_control(control_mapping_sources, name, params::Dict{String,<:Any})
Creates a new custom control in Audit Manager.
# Arguments
- `control_mapping_sources`: The data mapping sources for the control.
- `name`: The name of the control.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"actionPlanInstructions"`: The recommended actions to carry out if the control isn't
fulfilled.
- `"actionPlanTitle"`: The title of the action plan for remediating the control.
- `"description"`: The description of the control.
- `"tags"`: The tags that are associated with the control.
- `"testingInformation"`: The steps to follow to determine if the control is satisfied.
"""
function create_control(
controlMappingSources, name; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/controls",
Dict{String,Any}("controlMappingSources" => controlMappingSources, "name" => name);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function create_control(
controlMappingSources,
name,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"POST",
"/controls",
Dict{String,Any}(
mergewith(
_merge,
Dict{String,Any}(
"controlMappingSources" => controlMappingSources, "name" => name
),
params,
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment(assessment_id)
delete_assessment(assessment_id, params::Dict{String,<:Any})
Deletes an assessment in Audit Manager.
# Arguments
- `assessment_id`: The identifier for the assessment.
"""
function delete_assessment(assessmentId; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"DELETE",
"/assessments/$(assessmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment(
assessmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"DELETE",
"/assessments/$(assessmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_framework(framework_id)
delete_assessment_framework(framework_id, params::Dict{String,<:Any})
Deletes a custom framework in Audit Manager.
# Arguments
- `framework_id`: The identifier for the custom framework.
"""
function delete_assessment_framework(
frameworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"DELETE",
"/assessmentFrameworks/$(frameworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_framework(
frameworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"DELETE",
"/assessmentFrameworks/$(frameworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_framework_share(request_id, request_type)
delete_assessment_framework_share(request_id, request_type, params::Dict{String,<:Any})
Deletes a share request for a custom framework in Audit Manager.
# Arguments
- `request_id`: The unique identifier for the share request to be deleted.
- `request_type`: Specifies whether the share request is a sent request or a received
request.
"""
function delete_assessment_framework_share(
requestId, requestType; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"DELETE",
"/assessmentFrameworkShareRequests/$(requestId)",
Dict{String,Any}("requestType" => requestType);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_framework_share(
requestId,
requestType,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"DELETE",
"/assessmentFrameworkShareRequests/$(requestId)",
Dict{String,Any}(
mergewith(_merge, Dict{String,Any}("requestType" => requestType), params)
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_assessment_report(assessment_id, assessment_report_id)
delete_assessment_report(assessment_id, assessment_report_id, params::Dict{String,<:Any})
Deletes an assessment report in Audit Manager. When you run the DeleteAssessmentReport
operation, Audit Manager attempts to delete the following data: The specified assessment
report that’s stored in your S3 bucket The associated metadata that’s stored in Audit
Manager If Audit Manager can’t access the assessment report in your S3 bucket, the
report isn’t deleted. In this event, the DeleteAssessmentReport operation doesn’t fail.
Instead, it proceeds to delete the associated metadata only. You must then delete the
assessment report from the S3 bucket yourself. This scenario happens when Audit Manager
receives a 403 (Forbidden) or 404 (Not Found) error from Amazon S3. To avoid this, make
sure that your S3 bucket is available, and that you configured the correct permissions for
Audit Manager to delete resources in your S3 bucket. For an example permissions policy that
you can use, see Assessment report destination permissions in the Audit Manager User Guide.
For information about the issues that could cause a 403 (Forbidden) or 404 (Not Found)
error from Amazon S3, see List of Error Codes in the Amazon Simple Storage Service API
Reference.
# Arguments
- `assessment_id`: The unique identifier for the assessment.
- `assessment_report_id`: The unique identifier for the assessment report.
"""
function delete_assessment_report(
assessmentId, assessmentReportId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"DELETE",
"/assessments/$(assessmentId)/reports/$(assessmentReportId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_assessment_report(
assessmentId,
assessmentReportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"DELETE",
"/assessments/$(assessmentId)/reports/$(assessmentReportId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
delete_control(control_id)
delete_control(control_id, params::Dict{String,<:Any})
Deletes a custom control in Audit Manager.
# Arguments
- `control_id`: The unique identifier for the control.
"""
function delete_control(controlId; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"DELETE",
"/controls/$(controlId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function delete_control(
controlId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"DELETE",
"/controls/$(controlId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_account()
deregister_account(params::Dict{String,<:Any})
Deregisters an account in Audit Manager. Before you deregister, you can use the
UpdateSettings API operation to set your preferred data retention policy. By default, Audit
Manager retains your data. If you want to delete your data, you can use the
DeregistrationPolicy attribute to request the deletion of your data. For more information
about data retention, see Data Protection in the Audit Manager User Guide.
"""
function deregister_account(; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"POST",
"/account/deregisterAccount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/account/deregisterAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
deregister_organization_admin_account()
deregister_organization_admin_account(params::Dict{String,<:Any})
Removes the specified Amazon Web Services account as a delegated administrator for Audit
Manager. When you remove a delegated administrator from your Audit Manager settings, you
continue to have access to the evidence that you previously collected under that account.
This is also the case when you deregister a delegated administrator from Organizations.
However, Audit Manager stops collecting and attaching evidence to that delegated
administrator account moving forward. Keep in mind the following cleanup task if you use
evidence finder: Before you use your management account to remove a delegated
administrator, make sure that the current delegated administrator account signs in to Audit
Manager and disables evidence finder first. Disabling evidence finder automatically deletes
the event data store that was created in their account when they enabled evidence finder.
If this task isn’t completed, the event data store remains in their account. In this
case, we recommend that the original delegated administrator goes to CloudTrail Lake and
manually deletes the event data store. This cleanup task is necessary to ensure that you
don't end up with multiple event data stores. Audit Manager ignores an unused event data
store after you remove or change a delegated administrator account. However, the unused
event data store continues to incur storage costs from CloudTrail Lake if you don't delete
it. When you deregister a delegated administrator account for Audit Manager, the data for
that account isn’t deleted. If you want to delete resource data for a delegated
administrator account, you must perform that task separately before you deregister the
account. Either, you can do this in the Audit Manager console. Or, you can use one of the
delete API operations that are provided by Audit Manager. To delete your Audit Manager
resource data, see the following instructions: DeleteAssessment (see also: Deleting an
assessment in the Audit Manager User Guide) DeleteAssessmentFramework (see also:
Deleting a custom framework in the Audit Manager User Guide)
DeleteAssessmentFrameworkShare (see also: Deleting a share request in the Audit Manager
User Guide) DeleteAssessmentReport (see also: Deleting an assessment report in the Audit
Manager User Guide) DeleteControl (see also: Deleting a custom control in the Audit
Manager User Guide) At this time, Audit Manager doesn't provide an option to delete
evidence for a specific delegated administrator. Instead, when your management account
deregisters Audit Manager, we perform a cleanup for the current delegated administrator
account at the time of deregistration.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"adminAccountId"`: The identifier for the administrator account.
"""
function deregister_organization_admin_account(;
aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/account/deregisterOrganizationAdminAccount";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function deregister_organization_admin_account(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"POST",
"/account/deregisterOrganizationAdminAccount",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
disassociate_assessment_report_evidence_folder(assessment_id, evidence_folder_id)
disassociate_assessment_report_evidence_folder(assessment_id, evidence_folder_id, params::Dict{String,<:Any})
Disassociates an evidence folder from the specified assessment report in Audit Manager.
# Arguments
- `assessment_id`: The unique identifier for the assessment.
- `evidence_folder_id`: The unique identifier for the folder that the evidence is stored
in.
"""
function disassociate_assessment_report_evidence_folder(
assessmentId, evidenceFolderId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/disassociateFromAssessmentReport",
Dict{String,Any}("evidenceFolderId" => evidenceFolderId);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function disassociate_assessment_report_evidence_folder(
assessmentId,
evidenceFolderId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"PUT",
"/assessments/$(assessmentId)/disassociateFromAssessmentReport",
Dict{String,Any}(
mergewith(
_merge, Dict{String,Any}("evidenceFolderId" => evidenceFolderId), params
),
);
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_account_status()
get_account_status(params::Dict{String,<:Any})
Returns the registration status of an account in Audit Manager.
"""
function get_account_status(; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"GET", "/account/status"; aws_config=aws_config, feature_set=SERVICE_FEATURE_SET
)
end
function get_account_status(
params::AbstractDict{String}; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"GET",
"/account/status",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assessment(assessment_id)
get_assessment(assessment_id, params::Dict{String,<:Any})
Returns an assessment from Audit Manager.
# Arguments
- `assessment_id`: The unique identifier for the assessment.
"""
function get_assessment(assessmentId; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"GET",
"/assessments/$(assessmentId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assessment(
assessmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"GET",
"/assessments/$(assessmentId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assessment_framework(framework_id)
get_assessment_framework(framework_id, params::Dict{String,<:Any})
Returns a framework from Audit Manager.
# Arguments
- `framework_id`: The identifier for the framework.
"""
function get_assessment_framework(
frameworkId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"GET",
"/assessmentFrameworks/$(frameworkId)";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assessment_framework(
frameworkId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"GET",
"/assessmentFrameworks/$(frameworkId)",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_assessment_report_url(assessment_id, assessment_report_id)
get_assessment_report_url(assessment_id, assessment_report_id, params::Dict{String,<:Any})
Returns the URL of an assessment report in Audit Manager.
# Arguments
- `assessment_id`: The unique identifier for the assessment.
- `assessment_report_id`: The unique identifier for the assessment report.
"""
function get_assessment_report_url(
assessmentId, assessmentReportId; aws_config::AbstractAWSConfig=global_aws_config()
)
return auditmanager(
"GET",
"/assessments/$(assessmentId)/reports/$(assessmentReportId)/url";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_assessment_report_url(
assessmentId,
assessmentReportId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"GET",
"/assessments/$(assessmentId)/reports/$(assessmentReportId)/url",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
"""
get_change_logs(assessment_id)
get_change_logs(assessment_id, params::Dict{String,<:Any})
Returns a list of changelogs from Audit Manager.
# Arguments
- `assessment_id`: The unique identifier for the assessment.
# Optional Parameters
Optional parameters can be passed as a `params::Dict{String,<:Any}`. Valid keys are:
- `"controlId"`: The unique identifier for the control.
- `"controlSetId"`: The unique identifier for the control set.
- `"maxResults"`: Represents the maximum number of results on a page or for an API request
call.
- `"nextToken"`: The pagination token that's used to fetch the next set of results.
"""
function get_change_logs(assessmentId; aws_config::AbstractAWSConfig=global_aws_config())
return auditmanager(
"GET",
"/assessments/$(assessmentId)/changelogs";
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end
function get_change_logs(
assessmentId,
params::AbstractDict{String};
aws_config::AbstractAWSConfig=global_aws_config(),
)
return auditmanager(
"GET",
"/assessments/$(assessmentId)/changelogs",
params;
aws_config=aws_config,
feature_set=SERVICE_FEATURE_SET,
)
end