@aws-sdk/client-auditmanager 3.379.1 → 3.385.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.
- package/dist-types/models/models_0.d.ts +556 -0
- package/package.json +5 -5
|
@@ -51,14 +51,17 @@ export type ActionEnum = (typeof ActionEnum)[keyof typeof ActionEnum];
|
|
|
51
51
|
*/
|
|
52
52
|
export interface AWSAccount {
|
|
53
53
|
/**
|
|
54
|
+
* @public
|
|
54
55
|
* <p> The identifier for the Amazon Web Services account. </p>
|
|
55
56
|
*/
|
|
56
57
|
id?: string;
|
|
57
58
|
/**
|
|
59
|
+
* @public
|
|
58
60
|
* <p> The email address that's associated with the Amazon Web Services account. </p>
|
|
59
61
|
*/
|
|
60
62
|
emailAddress?: string;
|
|
61
63
|
/**
|
|
64
|
+
* @public
|
|
62
65
|
* <p> The name of the Amazon Web Services account. </p>
|
|
63
66
|
*/
|
|
64
67
|
name?: string;
|
|
@@ -70,14 +73,17 @@ export interface AWSAccount {
|
|
|
70
73
|
*/
|
|
71
74
|
export interface ControlComment {
|
|
72
75
|
/**
|
|
76
|
+
* @public
|
|
73
77
|
* <p> The name of the user who authored the comment. </p>
|
|
74
78
|
*/
|
|
75
79
|
authorName?: string;
|
|
76
80
|
/**
|
|
81
|
+
* @public
|
|
77
82
|
* <p> The body text of a control comment. </p>
|
|
78
83
|
*/
|
|
79
84
|
commentBody?: string;
|
|
80
85
|
/**
|
|
86
|
+
* @public
|
|
81
87
|
* <p> The time when the comment was posted. </p>
|
|
82
88
|
*/
|
|
83
89
|
postedDate?: Date;
|
|
@@ -115,38 +121,47 @@ export type ControlStatus = (typeof ControlStatus)[keyof typeof ControlStatus];
|
|
|
115
121
|
*/
|
|
116
122
|
export interface AssessmentControl {
|
|
117
123
|
/**
|
|
124
|
+
* @public
|
|
118
125
|
* <p> The identifier for the control. </p>
|
|
119
126
|
*/
|
|
120
127
|
id?: string;
|
|
121
128
|
/**
|
|
129
|
+
* @public
|
|
122
130
|
* <p> The name of the control. </p>
|
|
123
131
|
*/
|
|
124
132
|
name?: string;
|
|
125
133
|
/**
|
|
134
|
+
* @public
|
|
126
135
|
* <p> The description of the control. </p>
|
|
127
136
|
*/
|
|
128
137
|
description?: string;
|
|
129
138
|
/**
|
|
139
|
+
* @public
|
|
130
140
|
* <p> The status of the control. </p>
|
|
131
141
|
*/
|
|
132
142
|
status?: ControlStatus | string;
|
|
133
143
|
/**
|
|
144
|
+
* @public
|
|
134
145
|
* <p> The response of the control. </p>
|
|
135
146
|
*/
|
|
136
147
|
response?: ControlResponse | string;
|
|
137
148
|
/**
|
|
149
|
+
* @public
|
|
138
150
|
* <p> The list of comments that's attached to the control. </p>
|
|
139
151
|
*/
|
|
140
152
|
comments?: ControlComment[];
|
|
141
153
|
/**
|
|
154
|
+
* @public
|
|
142
155
|
* <p> The list of data sources for the evidence. </p>
|
|
143
156
|
*/
|
|
144
157
|
evidenceSources?: string[];
|
|
145
158
|
/**
|
|
159
|
+
* @public
|
|
146
160
|
* <p> The amount of evidence that's collected for the control. </p>
|
|
147
161
|
*/
|
|
148
162
|
evidenceCount?: number;
|
|
149
163
|
/**
|
|
164
|
+
* @public
|
|
150
165
|
* <p> The amount of evidence in the assessment report. </p>
|
|
151
166
|
*/
|
|
152
167
|
assessmentReportEvidenceCount?: number;
|
|
@@ -182,26 +197,32 @@ export type DelegationStatus = (typeof DelegationStatus)[keyof typeof Delegation
|
|
|
182
197
|
*/
|
|
183
198
|
export interface Delegation {
|
|
184
199
|
/**
|
|
200
|
+
* @public
|
|
185
201
|
* <p> The unique identifier for the delegation. </p>
|
|
186
202
|
*/
|
|
187
203
|
id?: string;
|
|
188
204
|
/**
|
|
205
|
+
* @public
|
|
189
206
|
* <p> The name of the assessment that's associated with the delegation. </p>
|
|
190
207
|
*/
|
|
191
208
|
assessmentName?: string;
|
|
192
209
|
/**
|
|
210
|
+
* @public
|
|
193
211
|
* <p> The identifier for the assessment that's associated with the delegation. </p>
|
|
194
212
|
*/
|
|
195
213
|
assessmentId?: string;
|
|
196
214
|
/**
|
|
215
|
+
* @public
|
|
197
216
|
* <p> The status of the delegation. </p>
|
|
198
217
|
*/
|
|
199
218
|
status?: DelegationStatus | string;
|
|
200
219
|
/**
|
|
220
|
+
* @public
|
|
201
221
|
* <p> The Amazon Resource Name (ARN) of the IAM role. </p>
|
|
202
222
|
*/
|
|
203
223
|
roleArn?: string;
|
|
204
224
|
/**
|
|
225
|
+
* @public
|
|
205
226
|
* <p> The type of customer persona. </p>
|
|
206
227
|
* <note>
|
|
207
228
|
* <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be
|
|
@@ -214,22 +235,27 @@ export interface Delegation {
|
|
|
214
235
|
*/
|
|
215
236
|
roleType?: RoleType | string;
|
|
216
237
|
/**
|
|
238
|
+
* @public
|
|
217
239
|
* <p> Specifies when the delegation was created. </p>
|
|
218
240
|
*/
|
|
219
241
|
creationTime?: Date;
|
|
220
242
|
/**
|
|
243
|
+
* @public
|
|
221
244
|
* <p> Specifies when the delegation was last updated. </p>
|
|
222
245
|
*/
|
|
223
246
|
lastUpdated?: Date;
|
|
224
247
|
/**
|
|
248
|
+
* @public
|
|
225
249
|
* <p> The identifier for the control set that's associated with the delegation. </p>
|
|
226
250
|
*/
|
|
227
251
|
controlSetId?: string;
|
|
228
252
|
/**
|
|
253
|
+
* @public
|
|
229
254
|
* <p> The comment that's related to the delegation. </p>
|
|
230
255
|
*/
|
|
231
256
|
comment?: string;
|
|
232
257
|
/**
|
|
258
|
+
* @public
|
|
233
259
|
* <p> The user or role that created the delegation. </p>
|
|
234
260
|
*/
|
|
235
261
|
createdBy?: string;
|
|
@@ -241,6 +267,7 @@ export interface Delegation {
|
|
|
241
267
|
*/
|
|
242
268
|
export interface Role {
|
|
243
269
|
/**
|
|
270
|
+
* @public
|
|
244
271
|
* <p> The type of customer persona. </p>
|
|
245
272
|
* <note>
|
|
246
273
|
* <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be
|
|
@@ -253,6 +280,7 @@ export interface Role {
|
|
|
253
280
|
*/
|
|
254
281
|
roleType: RoleType | string | undefined;
|
|
255
282
|
/**
|
|
283
|
+
* @public
|
|
256
284
|
* <p> The Amazon Resource Name (ARN) of the IAM role. </p>
|
|
257
285
|
*/
|
|
258
286
|
roleArn: string | undefined;
|
|
@@ -276,36 +304,44 @@ export type ControlSetStatus = (typeof ControlSetStatus)[keyof typeof ControlSet
|
|
|
276
304
|
*/
|
|
277
305
|
export interface AssessmentControlSet {
|
|
278
306
|
/**
|
|
307
|
+
* @public
|
|
279
308
|
* <p> The identifier of the control set in the assessment. This is the control set name in a
|
|
280
309
|
* plain string format. </p>
|
|
281
310
|
*/
|
|
282
311
|
id?: string;
|
|
283
312
|
/**
|
|
313
|
+
* @public
|
|
284
314
|
* <p> The description for the control set. </p>
|
|
285
315
|
*/
|
|
286
316
|
description?: string;
|
|
287
317
|
/**
|
|
318
|
+
* @public
|
|
288
319
|
* <p> The current status of the control set. </p>
|
|
289
320
|
*/
|
|
290
321
|
status?: ControlSetStatus | string;
|
|
291
322
|
/**
|
|
323
|
+
* @public
|
|
292
324
|
* <p> The roles that are associated with the control set. </p>
|
|
293
325
|
*/
|
|
294
326
|
roles?: Role[];
|
|
295
327
|
/**
|
|
328
|
+
* @public
|
|
296
329
|
* <p> The list of controls that's contained with the control set. </p>
|
|
297
330
|
*/
|
|
298
331
|
controls?: AssessmentControl[];
|
|
299
332
|
/**
|
|
333
|
+
* @public
|
|
300
334
|
* <p> The delegations that are associated with the control set. </p>
|
|
301
335
|
*/
|
|
302
336
|
delegations?: Delegation[];
|
|
303
337
|
/**
|
|
338
|
+
* @public
|
|
304
339
|
* <p> The total number of evidence objects that are retrieved automatically for the control
|
|
305
340
|
* set. </p>
|
|
306
341
|
*/
|
|
307
342
|
systemEvidenceCount?: number;
|
|
308
343
|
/**
|
|
344
|
+
* @public
|
|
309
345
|
* <p> The total number of evidence objects that are uploaded manually to the control set.
|
|
310
346
|
* </p>
|
|
311
347
|
*/
|
|
@@ -317,18 +353,22 @@ export interface AssessmentControlSet {
|
|
|
317
353
|
*/
|
|
318
354
|
export interface FrameworkMetadata {
|
|
319
355
|
/**
|
|
356
|
+
* @public
|
|
320
357
|
* <p> The name of the framework. </p>
|
|
321
358
|
*/
|
|
322
359
|
name?: string;
|
|
323
360
|
/**
|
|
361
|
+
* @public
|
|
324
362
|
* <p> The description of the framework. </p>
|
|
325
363
|
*/
|
|
326
364
|
description?: string;
|
|
327
365
|
/**
|
|
366
|
+
* @public
|
|
328
367
|
* <p> The logo that's associated with the framework. </p>
|
|
329
368
|
*/
|
|
330
369
|
logo?: string;
|
|
331
370
|
/**
|
|
371
|
+
* @public
|
|
332
372
|
* <p> The compliance standard that's associated with the framework. For example, this could
|
|
333
373
|
* be PCI DSS or HIPAA. </p>
|
|
334
374
|
*/
|
|
@@ -341,18 +381,22 @@ export interface FrameworkMetadata {
|
|
|
341
381
|
*/
|
|
342
382
|
export interface AssessmentFramework {
|
|
343
383
|
/**
|
|
384
|
+
* @public
|
|
344
385
|
* <p> The unique identifier for the framework. </p>
|
|
345
386
|
*/
|
|
346
387
|
id?: string;
|
|
347
388
|
/**
|
|
389
|
+
* @public
|
|
348
390
|
* <p> The Amazon Resource Name (ARN) of the framework. </p>
|
|
349
391
|
*/
|
|
350
392
|
arn?: string;
|
|
351
393
|
/**
|
|
394
|
+
* @public
|
|
352
395
|
* <p> The metadata of a framework, such as the name, ID, or description. </p>
|
|
353
396
|
*/
|
|
354
397
|
metadata?: FrameworkMetadata;
|
|
355
398
|
/**
|
|
399
|
+
* @public
|
|
356
400
|
* <p> The control sets that are associated with the framework. </p>
|
|
357
401
|
*/
|
|
358
402
|
controlSets?: AssessmentControlSet[];
|
|
@@ -375,10 +419,12 @@ export type AssessmentReportDestinationType = (typeof AssessmentReportDestinatio
|
|
|
375
419
|
*/
|
|
376
420
|
export interface AssessmentReportsDestination {
|
|
377
421
|
/**
|
|
422
|
+
* @public
|
|
378
423
|
* <p> The destination type, such as Amazon S3. </p>
|
|
379
424
|
*/
|
|
380
425
|
destinationType?: AssessmentReportDestinationType | string;
|
|
381
426
|
/**
|
|
427
|
+
* @public
|
|
382
428
|
* <p> The destination bucket where Audit Manager stores assessment reports. </p>
|
|
383
429
|
*/
|
|
384
430
|
destination?: string;
|
|
@@ -404,6 +450,7 @@ export interface AssessmentReportsDestination {
|
|
|
404
450
|
*/
|
|
405
451
|
export interface AWSService {
|
|
406
452
|
/**
|
|
453
|
+
* @public
|
|
407
454
|
* <p> The name of the Amazon Web Service. </p>
|
|
408
455
|
*/
|
|
409
456
|
serviceName?: string;
|
|
@@ -415,11 +462,13 @@ export interface AWSService {
|
|
|
415
462
|
*/
|
|
416
463
|
export interface Scope {
|
|
417
464
|
/**
|
|
465
|
+
* @public
|
|
418
466
|
* <p> The Amazon Web Services accounts that are included in the scope of the assessment.
|
|
419
467
|
* </p>
|
|
420
468
|
*/
|
|
421
469
|
awsAccounts?: AWSAccount[];
|
|
422
470
|
/**
|
|
471
|
+
* @public
|
|
423
472
|
* <p> The Amazon Web Services services that are included in the scope of the assessment.
|
|
424
473
|
* </p>
|
|
425
474
|
*/
|
|
@@ -443,48 +492,59 @@ export type AssessmentStatus = (typeof AssessmentStatus)[keyof typeof Assessment
|
|
|
443
492
|
*/
|
|
444
493
|
export interface AssessmentMetadata {
|
|
445
494
|
/**
|
|
495
|
+
* @public
|
|
446
496
|
* <p> The name of the assessment. </p>
|
|
447
497
|
*/
|
|
448
498
|
name?: string;
|
|
449
499
|
/**
|
|
500
|
+
* @public
|
|
450
501
|
* <p> The unique identifier for the assessment. </p>
|
|
451
502
|
*/
|
|
452
503
|
id?: string;
|
|
453
504
|
/**
|
|
505
|
+
* @public
|
|
454
506
|
* <p> The description of the assessment. </p>
|
|
455
507
|
*/
|
|
456
508
|
description?: string;
|
|
457
509
|
/**
|
|
510
|
+
* @public
|
|
458
511
|
* <p> The name of the compliance standard that's related to the assessment, such as PCI-DSS.
|
|
459
512
|
* </p>
|
|
460
513
|
*/
|
|
461
514
|
complianceType?: string;
|
|
462
515
|
/**
|
|
516
|
+
* @public
|
|
463
517
|
* <p> The overall status of the assessment. </p>
|
|
464
518
|
*/
|
|
465
519
|
status?: AssessmentStatus | string;
|
|
466
520
|
/**
|
|
521
|
+
* @public
|
|
467
522
|
* <p> The destination that evidence reports are stored in for the assessment. </p>
|
|
468
523
|
*/
|
|
469
524
|
assessmentReportsDestination?: AssessmentReportsDestination;
|
|
470
525
|
/**
|
|
526
|
+
* @public
|
|
471
527
|
* <p> The wrapper of Amazon Web Services accounts and services that are in scope for the
|
|
472
528
|
* assessment. </p>
|
|
473
529
|
*/
|
|
474
530
|
scope?: Scope;
|
|
475
531
|
/**
|
|
532
|
+
* @public
|
|
476
533
|
* <p> The roles that are associated with the assessment. </p>
|
|
477
534
|
*/
|
|
478
535
|
roles?: Role[];
|
|
479
536
|
/**
|
|
537
|
+
* @public
|
|
480
538
|
* <p> The delegations that are associated with the assessment. </p>
|
|
481
539
|
*/
|
|
482
540
|
delegations?: Delegation[];
|
|
483
541
|
/**
|
|
542
|
+
* @public
|
|
484
543
|
* <p> Specifies when the assessment was created. </p>
|
|
485
544
|
*/
|
|
486
545
|
creationTime?: Date;
|
|
487
546
|
/**
|
|
547
|
+
* @public
|
|
488
548
|
* <p> The time of the most recent update. </p>
|
|
489
549
|
*/
|
|
490
550
|
lastUpdated?: Date;
|
|
@@ -496,22 +556,27 @@ export interface AssessmentMetadata {
|
|
|
496
556
|
*/
|
|
497
557
|
export interface Assessment {
|
|
498
558
|
/**
|
|
559
|
+
* @public
|
|
499
560
|
* <p> The Amazon Resource Name (ARN) of the assessment. </p>
|
|
500
561
|
*/
|
|
501
562
|
arn?: string;
|
|
502
563
|
/**
|
|
564
|
+
* @public
|
|
503
565
|
* <p> The Amazon Web Services account that's associated with the assessment. </p>
|
|
504
566
|
*/
|
|
505
567
|
awsAccount?: AWSAccount;
|
|
506
568
|
/**
|
|
569
|
+
* @public
|
|
507
570
|
* <p> The metadata for the assessment. </p>
|
|
508
571
|
*/
|
|
509
572
|
metadata?: AssessmentMetadata;
|
|
510
573
|
/**
|
|
574
|
+
* @public
|
|
511
575
|
* <p> The framework that the assessment was created from. </p>
|
|
512
576
|
*/
|
|
513
577
|
framework?: AssessmentFramework;
|
|
514
578
|
/**
|
|
579
|
+
* @public
|
|
515
580
|
* <p> The tags that are associated with the assessment. </p>
|
|
516
581
|
*/
|
|
517
582
|
tags?: Record<string, string>;
|
|
@@ -522,80 +587,98 @@ export interface Assessment {
|
|
|
522
587
|
*/
|
|
523
588
|
export interface AssessmentEvidenceFolder {
|
|
524
589
|
/**
|
|
590
|
+
* @public
|
|
525
591
|
* <p> The name of the evidence folder. </p>
|
|
526
592
|
*/
|
|
527
593
|
name?: string;
|
|
528
594
|
/**
|
|
595
|
+
* @public
|
|
529
596
|
* <p> The date when the first evidence was added to the evidence folder. </p>
|
|
530
597
|
*/
|
|
531
598
|
date?: Date;
|
|
532
599
|
/**
|
|
600
|
+
* @public
|
|
533
601
|
* <p> The identifier for the assessment. </p>
|
|
534
602
|
*/
|
|
535
603
|
assessmentId?: string;
|
|
536
604
|
/**
|
|
605
|
+
* @public
|
|
537
606
|
* <p> The identifier for the control set. </p>
|
|
538
607
|
*/
|
|
539
608
|
controlSetId?: string;
|
|
540
609
|
/**
|
|
610
|
+
* @public
|
|
541
611
|
* <p> The unique identifier for the control. </p>
|
|
542
612
|
*/
|
|
543
613
|
controlId?: string;
|
|
544
614
|
/**
|
|
615
|
+
* @public
|
|
545
616
|
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
546
617
|
*/
|
|
547
618
|
id?: string;
|
|
548
619
|
/**
|
|
620
|
+
* @public
|
|
549
621
|
* <p> The Amazon Web Service that the evidence was collected from. </p>
|
|
550
622
|
*/
|
|
551
623
|
dataSource?: string;
|
|
552
624
|
/**
|
|
625
|
+
* @public
|
|
553
626
|
* <p> The name of the user who created the evidence folder. </p>
|
|
554
627
|
*/
|
|
555
628
|
author?: string;
|
|
556
629
|
/**
|
|
630
|
+
* @public
|
|
557
631
|
* <p> The total amount of evidence in the evidence folder. </p>
|
|
558
632
|
*/
|
|
559
633
|
totalEvidence?: number;
|
|
560
634
|
/**
|
|
635
|
+
* @public
|
|
561
636
|
* <p> The total count of evidence that's included in the assessment report. </p>
|
|
562
637
|
*/
|
|
563
638
|
assessmentReportSelectionCount?: number;
|
|
564
639
|
/**
|
|
640
|
+
* @public
|
|
565
641
|
* <p> The name of the control. </p>
|
|
566
642
|
*/
|
|
567
643
|
controlName?: string;
|
|
568
644
|
/**
|
|
645
|
+
* @public
|
|
569
646
|
* <p> The amount of evidence that's included in the evidence folder. </p>
|
|
570
647
|
*/
|
|
571
648
|
evidenceResourcesIncludedCount?: number;
|
|
572
649
|
/**
|
|
650
|
+
* @public
|
|
573
651
|
* <p> The number of evidence that falls under the configuration data category. This evidence
|
|
574
652
|
* is collected from configuration snapshots of other Amazon Web Services such as
|
|
575
653
|
* Amazon EC2, Amazon S3, or IAM. </p>
|
|
576
654
|
*/
|
|
577
655
|
evidenceByTypeConfigurationDataCount?: number;
|
|
578
656
|
/**
|
|
657
|
+
* @public
|
|
579
658
|
* <p> The number of evidence that falls under the manual category. This evidence is imported
|
|
580
659
|
* manually. </p>
|
|
581
660
|
*/
|
|
582
661
|
evidenceByTypeManualCount?: number;
|
|
583
662
|
/**
|
|
663
|
+
* @public
|
|
584
664
|
* <p> The number of evidence that falls under the compliance check category. This evidence is
|
|
585
665
|
* collected from Config or Security Hub. </p>
|
|
586
666
|
*/
|
|
587
667
|
evidenceByTypeComplianceCheckCount?: number;
|
|
588
668
|
/**
|
|
669
|
+
* @public
|
|
589
670
|
* <p> The total number of issues that were reported directly from Security Hub,
|
|
590
671
|
* Config, or both. </p>
|
|
591
672
|
*/
|
|
592
673
|
evidenceByTypeComplianceCheckIssuesCount?: number;
|
|
593
674
|
/**
|
|
675
|
+
* @public
|
|
594
676
|
* <p> The number of evidence that falls under the user activity category. This evidence is
|
|
595
677
|
* collected from CloudTrail logs. </p>
|
|
596
678
|
*/
|
|
597
679
|
evidenceByTypeUserActivityCount?: number;
|
|
598
680
|
/**
|
|
681
|
+
* @public
|
|
599
682
|
* <p> The total number of Amazon Web Services resources that were assessed to generate the
|
|
600
683
|
* evidence. </p>
|
|
601
684
|
*/
|
|
@@ -619,47 +702,58 @@ export type FrameworkType = (typeof FrameworkType)[keyof typeof FrameworkType];
|
|
|
619
702
|
*/
|
|
620
703
|
export interface AssessmentFrameworkMetadata {
|
|
621
704
|
/**
|
|
705
|
+
* @public
|
|
622
706
|
* <p> The Amazon Resource Name (ARN) of the framework. </p>
|
|
623
707
|
*/
|
|
624
708
|
arn?: string;
|
|
625
709
|
/**
|
|
710
|
+
* @public
|
|
626
711
|
* <p> The unique identifier for the framework. </p>
|
|
627
712
|
*/
|
|
628
713
|
id?: string;
|
|
629
714
|
/**
|
|
715
|
+
* @public
|
|
630
716
|
* <p> The framework type, such as a standard framework or a custom framework. </p>
|
|
631
717
|
*/
|
|
632
718
|
type?: FrameworkType | string;
|
|
633
719
|
/**
|
|
720
|
+
* @public
|
|
634
721
|
* <p> The name of the framework. </p>
|
|
635
722
|
*/
|
|
636
723
|
name?: string;
|
|
637
724
|
/**
|
|
725
|
+
* @public
|
|
638
726
|
* <p> The description of the framework. </p>
|
|
639
727
|
*/
|
|
640
728
|
description?: string;
|
|
641
729
|
/**
|
|
730
|
+
* @public
|
|
642
731
|
* <p> The logo that's associated with the framework. </p>
|
|
643
732
|
*/
|
|
644
733
|
logo?: string;
|
|
645
734
|
/**
|
|
735
|
+
* @public
|
|
646
736
|
* <p> The compliance type that the new custom framework supports, such as CIS or HIPAA.
|
|
647
737
|
* </p>
|
|
648
738
|
*/
|
|
649
739
|
complianceType?: string;
|
|
650
740
|
/**
|
|
741
|
+
* @public
|
|
651
742
|
* <p> The number of controls that are associated with the framework. </p>
|
|
652
743
|
*/
|
|
653
744
|
controlsCount?: number;
|
|
654
745
|
/**
|
|
746
|
+
* @public
|
|
655
747
|
* <p> The number of control sets that are associated with the framework. </p>
|
|
656
748
|
*/
|
|
657
749
|
controlSetsCount?: number;
|
|
658
750
|
/**
|
|
751
|
+
* @public
|
|
659
752
|
* <p> The time when the framework was created. </p>
|
|
660
753
|
*/
|
|
661
754
|
createdAt?: Date;
|
|
662
755
|
/**
|
|
756
|
+
* @public
|
|
663
757
|
* <p> The time when the framework was most recently updated. </p>
|
|
664
758
|
*/
|
|
665
759
|
lastUpdatedAt?: Date;
|
|
@@ -688,62 +782,77 @@ export type ShareRequestStatus = (typeof ShareRequestStatus)[keyof typeof ShareR
|
|
|
688
782
|
*/
|
|
689
783
|
export interface AssessmentFrameworkShareRequest {
|
|
690
784
|
/**
|
|
785
|
+
* @public
|
|
691
786
|
* <p> The unique identifier for the share request. </p>
|
|
692
787
|
*/
|
|
693
788
|
id?: string;
|
|
694
789
|
/**
|
|
790
|
+
* @public
|
|
695
791
|
* <p>The unique identifier for the shared custom framework. </p>
|
|
696
792
|
*/
|
|
697
793
|
frameworkId?: string;
|
|
698
794
|
/**
|
|
795
|
+
* @public
|
|
699
796
|
* <p> The name of the custom framework that the share request is for. </p>
|
|
700
797
|
*/
|
|
701
798
|
frameworkName?: string;
|
|
702
799
|
/**
|
|
800
|
+
* @public
|
|
703
801
|
* <p>The description of the shared custom framework.</p>
|
|
704
802
|
*/
|
|
705
803
|
frameworkDescription?: string;
|
|
706
804
|
/**
|
|
805
|
+
* @public
|
|
707
806
|
* <p> The status of the share request. </p>
|
|
708
807
|
*/
|
|
709
808
|
status?: ShareRequestStatus | string;
|
|
710
809
|
/**
|
|
810
|
+
* @public
|
|
711
811
|
* <p> The Amazon Web Services account of the sender. </p>
|
|
712
812
|
*/
|
|
713
813
|
sourceAccount?: string;
|
|
714
814
|
/**
|
|
815
|
+
* @public
|
|
715
816
|
* <p> The Amazon Web Services account of the recipient. </p>
|
|
716
817
|
*/
|
|
717
818
|
destinationAccount?: string;
|
|
718
819
|
/**
|
|
820
|
+
* @public
|
|
719
821
|
* <p> The Amazon Web Services Region of the recipient. </p>
|
|
720
822
|
*/
|
|
721
823
|
destinationRegion?: string;
|
|
722
824
|
/**
|
|
825
|
+
* @public
|
|
723
826
|
* <p> The time when the share request expires. </p>
|
|
724
827
|
*/
|
|
725
828
|
expirationTime?: Date;
|
|
726
829
|
/**
|
|
830
|
+
* @public
|
|
727
831
|
* <p> The time when the share request was created. </p>
|
|
728
832
|
*/
|
|
729
833
|
creationTime?: Date;
|
|
730
834
|
/**
|
|
835
|
+
* @public
|
|
731
836
|
* <p> Specifies when the share request was last updated. </p>
|
|
732
837
|
*/
|
|
733
838
|
lastUpdated?: Date;
|
|
734
839
|
/**
|
|
840
|
+
* @public
|
|
735
841
|
* <p> An optional comment from the sender about the share request. </p>
|
|
736
842
|
*/
|
|
737
843
|
comment?: string;
|
|
738
844
|
/**
|
|
845
|
+
* @public
|
|
739
846
|
* <p>The number of standard controls that are part of the shared custom framework. </p>
|
|
740
847
|
*/
|
|
741
848
|
standardControlsCount?: number;
|
|
742
849
|
/**
|
|
850
|
+
* @public
|
|
743
851
|
* <p>The number of custom controls that are part of the shared custom framework.</p>
|
|
744
852
|
*/
|
|
745
853
|
customControlsCount?: number;
|
|
746
854
|
/**
|
|
855
|
+
* @public
|
|
747
856
|
* <p>The compliance type that the shared custom framework supports, such as CIS or
|
|
748
857
|
* HIPAA.</p>
|
|
749
858
|
*/
|
|
@@ -756,35 +865,43 @@ export interface AssessmentFrameworkShareRequest {
|
|
|
756
865
|
*/
|
|
757
866
|
export interface AssessmentMetadataItem {
|
|
758
867
|
/**
|
|
868
|
+
* @public
|
|
759
869
|
* <p> The name of the assessment. </p>
|
|
760
870
|
*/
|
|
761
871
|
name?: string;
|
|
762
872
|
/**
|
|
873
|
+
* @public
|
|
763
874
|
* <p> The unique identifier for the assessment. </p>
|
|
764
875
|
*/
|
|
765
876
|
id?: string;
|
|
766
877
|
/**
|
|
878
|
+
* @public
|
|
767
879
|
* <p> The name of the compliance standard that's related to the assessment, such as PCI-DSS.
|
|
768
880
|
* </p>
|
|
769
881
|
*/
|
|
770
882
|
complianceType?: string;
|
|
771
883
|
/**
|
|
884
|
+
* @public
|
|
772
885
|
* <p> The current status of the assessment. </p>
|
|
773
886
|
*/
|
|
774
887
|
status?: AssessmentStatus | string;
|
|
775
888
|
/**
|
|
889
|
+
* @public
|
|
776
890
|
* <p> The roles that are associated with the assessment. </p>
|
|
777
891
|
*/
|
|
778
892
|
roles?: Role[];
|
|
779
893
|
/**
|
|
894
|
+
* @public
|
|
780
895
|
* <p> The delegations that are associated with the assessment. </p>
|
|
781
896
|
*/
|
|
782
897
|
delegations?: Delegation[];
|
|
783
898
|
/**
|
|
899
|
+
* @public
|
|
784
900
|
* <p> Specifies when the assessment was created. </p>
|
|
785
901
|
*/
|
|
786
902
|
creationTime?: Date;
|
|
787
903
|
/**
|
|
904
|
+
* @public
|
|
788
905
|
* <p> The time of the most recent update. </p>
|
|
789
906
|
*/
|
|
790
907
|
lastUpdated?: Date;
|
|
@@ -811,38 +928,47 @@ export type AssessmentReportStatus = (typeof AssessmentReportStatus)[keyof typeo
|
|
|
811
928
|
*/
|
|
812
929
|
export interface AssessmentReport {
|
|
813
930
|
/**
|
|
931
|
+
* @public
|
|
814
932
|
* <p> The unique identifier for the assessment report. </p>
|
|
815
933
|
*/
|
|
816
934
|
id?: string;
|
|
817
935
|
/**
|
|
936
|
+
* @public
|
|
818
937
|
* <p> The name that's given to the assessment report. </p>
|
|
819
938
|
*/
|
|
820
939
|
name?: string;
|
|
821
940
|
/**
|
|
941
|
+
* @public
|
|
822
942
|
* <p> The description of the specified assessment report. </p>
|
|
823
943
|
*/
|
|
824
944
|
description?: string;
|
|
825
945
|
/**
|
|
946
|
+
* @public
|
|
826
947
|
* <p> The identifier for the specified Amazon Web Services account. </p>
|
|
827
948
|
*/
|
|
828
949
|
awsAccountId?: string;
|
|
829
950
|
/**
|
|
951
|
+
* @public
|
|
830
952
|
* <p> The identifier for the specified assessment. </p>
|
|
831
953
|
*/
|
|
832
954
|
assessmentId?: string;
|
|
833
955
|
/**
|
|
956
|
+
* @public
|
|
834
957
|
* <p> The name of the associated assessment. </p>
|
|
835
958
|
*/
|
|
836
959
|
assessmentName?: string;
|
|
837
960
|
/**
|
|
961
|
+
* @public
|
|
838
962
|
* <p> The name of the user who created the assessment report. </p>
|
|
839
963
|
*/
|
|
840
964
|
author?: string;
|
|
841
965
|
/**
|
|
966
|
+
* @public
|
|
842
967
|
* <p> The current status of the specified assessment report. </p>
|
|
843
968
|
*/
|
|
844
969
|
status?: AssessmentReportStatus | string;
|
|
845
970
|
/**
|
|
971
|
+
* @public
|
|
846
972
|
* <p> Specifies when the assessment report was created. </p>
|
|
847
973
|
*/
|
|
848
974
|
creationTime?: Date;
|
|
@@ -854,14 +980,17 @@ export interface AssessmentReport {
|
|
|
854
980
|
*/
|
|
855
981
|
export interface AssessmentReportEvidenceError {
|
|
856
982
|
/**
|
|
983
|
+
* @public
|
|
857
984
|
* <p> The identifier for the evidence. </p>
|
|
858
985
|
*/
|
|
859
986
|
evidenceId?: string;
|
|
860
987
|
/**
|
|
988
|
+
* @public
|
|
861
989
|
* <p> The error code that was returned. </p>
|
|
862
990
|
*/
|
|
863
991
|
errorCode?: string;
|
|
864
992
|
/**
|
|
993
|
+
* @public
|
|
865
994
|
* <p> The error message that was returned. </p>
|
|
866
995
|
*/
|
|
867
996
|
errorMessage?: string;
|
|
@@ -872,34 +1001,42 @@ export interface AssessmentReportEvidenceError {
|
|
|
872
1001
|
*/
|
|
873
1002
|
export interface AssessmentReportMetadata {
|
|
874
1003
|
/**
|
|
1004
|
+
* @public
|
|
875
1005
|
* <p> The unique identifier for the assessment report. </p>
|
|
876
1006
|
*/
|
|
877
1007
|
id?: string;
|
|
878
1008
|
/**
|
|
1009
|
+
* @public
|
|
879
1010
|
* <p> The name of the assessment report. </p>
|
|
880
1011
|
*/
|
|
881
1012
|
name?: string;
|
|
882
1013
|
/**
|
|
1014
|
+
* @public
|
|
883
1015
|
* <p> The description of the assessment report. </p>
|
|
884
1016
|
*/
|
|
885
1017
|
description?: string;
|
|
886
1018
|
/**
|
|
1019
|
+
* @public
|
|
887
1020
|
* <p> The unique identifier for the associated assessment. </p>
|
|
888
1021
|
*/
|
|
889
1022
|
assessmentId?: string;
|
|
890
1023
|
/**
|
|
1024
|
+
* @public
|
|
891
1025
|
* <p>The name of the associated assessment. </p>
|
|
892
1026
|
*/
|
|
893
1027
|
assessmentName?: string;
|
|
894
1028
|
/**
|
|
1029
|
+
* @public
|
|
895
1030
|
* <p> The name of the user who created the assessment report. </p>
|
|
896
1031
|
*/
|
|
897
1032
|
author?: string;
|
|
898
1033
|
/**
|
|
1034
|
+
* @public
|
|
899
1035
|
* <p> The current status of the assessment report. </p>
|
|
900
1036
|
*/
|
|
901
1037
|
status?: AssessmentReportStatus | string;
|
|
902
1038
|
/**
|
|
1039
|
+
* @public
|
|
903
1040
|
* <p> Specifies when the assessment report was created. </p>
|
|
904
1041
|
*/
|
|
905
1042
|
creationTime?: Date;
|
|
@@ -909,10 +1046,12 @@ export interface AssessmentReportMetadata {
|
|
|
909
1046
|
*/
|
|
910
1047
|
export interface AssociateAssessmentReportEvidenceFolderRequest {
|
|
911
1048
|
/**
|
|
1049
|
+
* @public
|
|
912
1050
|
* <p> The identifier for the assessment. </p>
|
|
913
1051
|
*/
|
|
914
1052
|
assessmentId: string | undefined;
|
|
915
1053
|
/**
|
|
1054
|
+
* @public
|
|
916
1055
|
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
917
1056
|
*/
|
|
918
1057
|
evidenceFolderId: string | undefined;
|
|
@@ -943,10 +1082,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
943
1082
|
readonly name: "ResourceNotFoundException";
|
|
944
1083
|
readonly $fault: "client";
|
|
945
1084
|
/**
|
|
1085
|
+
* @public
|
|
946
1086
|
* <p> The unique identifier for the resource. </p>
|
|
947
1087
|
*/
|
|
948
1088
|
resourceId: string | undefined;
|
|
949
1089
|
/**
|
|
1090
|
+
* @public
|
|
950
1091
|
* <p> The type of resource that's affected by the error. </p>
|
|
951
1092
|
*/
|
|
952
1093
|
resourceType: string | undefined;
|
|
@@ -961,10 +1102,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
961
1102
|
*/
|
|
962
1103
|
export interface ValidationExceptionField {
|
|
963
1104
|
/**
|
|
1105
|
+
* @public
|
|
964
1106
|
* <p> The name of the validation error. </p>
|
|
965
1107
|
*/
|
|
966
1108
|
name: string | undefined;
|
|
967
1109
|
/**
|
|
1110
|
+
* @public
|
|
968
1111
|
* <p> The body of the error message. </p>
|
|
969
1112
|
*/
|
|
970
1113
|
message: string | undefined;
|
|
@@ -991,10 +1134,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
991
1134
|
readonly name: "ValidationException";
|
|
992
1135
|
readonly $fault: "client";
|
|
993
1136
|
/**
|
|
1137
|
+
* @public
|
|
994
1138
|
* <p> The reason the request failed validation. </p>
|
|
995
1139
|
*/
|
|
996
1140
|
reason?: ValidationExceptionReason | string;
|
|
997
1141
|
/**
|
|
1142
|
+
* @public
|
|
998
1143
|
* <p> The fields that caused the error, if applicable. </p>
|
|
999
1144
|
*/
|
|
1000
1145
|
fields?: ValidationExceptionField[];
|
|
@@ -1008,14 +1153,17 @@ export declare class ValidationException extends __BaseException {
|
|
|
1008
1153
|
*/
|
|
1009
1154
|
export interface BatchAssociateAssessmentReportEvidenceRequest {
|
|
1010
1155
|
/**
|
|
1156
|
+
* @public
|
|
1011
1157
|
* <p> The identifier for the assessment. </p>
|
|
1012
1158
|
*/
|
|
1013
1159
|
assessmentId: string | undefined;
|
|
1014
1160
|
/**
|
|
1161
|
+
* @public
|
|
1015
1162
|
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
1016
1163
|
*/
|
|
1017
1164
|
evidenceFolderId: string | undefined;
|
|
1018
1165
|
/**
|
|
1166
|
+
* @public
|
|
1019
1167
|
* <p> The list of evidence identifiers. </p>
|
|
1020
1168
|
*/
|
|
1021
1169
|
evidenceIds: string[] | undefined;
|
|
@@ -1025,10 +1173,12 @@ export interface BatchAssociateAssessmentReportEvidenceRequest {
|
|
|
1025
1173
|
*/
|
|
1026
1174
|
export interface BatchAssociateAssessmentReportEvidenceResponse {
|
|
1027
1175
|
/**
|
|
1176
|
+
* @public
|
|
1028
1177
|
* <p> The list of evidence identifiers. </p>
|
|
1029
1178
|
*/
|
|
1030
1179
|
evidenceIds?: string[];
|
|
1031
1180
|
/**
|
|
1181
|
+
* @public
|
|
1032
1182
|
* <p> A list of errors that the <code>BatchAssociateAssessmentReportEvidence</code> API
|
|
1033
1183
|
* returned. </p>
|
|
1034
1184
|
*/
|
|
@@ -1041,18 +1191,22 @@ export interface BatchAssociateAssessmentReportEvidenceResponse {
|
|
|
1041
1191
|
*/
|
|
1042
1192
|
export interface CreateDelegationRequest {
|
|
1043
1193
|
/**
|
|
1194
|
+
* @public
|
|
1044
1195
|
* <p> A comment that's related to the delegation request. </p>
|
|
1045
1196
|
*/
|
|
1046
1197
|
comment?: string;
|
|
1047
1198
|
/**
|
|
1199
|
+
* @public
|
|
1048
1200
|
* <p> The unique identifier for the control set. </p>
|
|
1049
1201
|
*/
|
|
1050
1202
|
controlSetId?: string;
|
|
1051
1203
|
/**
|
|
1204
|
+
* @public
|
|
1052
1205
|
* <p> The Amazon Resource Name (ARN) of the IAM role. </p>
|
|
1053
1206
|
*/
|
|
1054
1207
|
roleArn?: string;
|
|
1055
1208
|
/**
|
|
1209
|
+
* @public
|
|
1056
1210
|
* <p> The type of customer persona. </p>
|
|
1057
1211
|
* <note>
|
|
1058
1212
|
* <p>In <code>CreateAssessment</code>, <code>roleType</code> can only be
|
|
@@ -1070,10 +1224,12 @@ export interface CreateDelegationRequest {
|
|
|
1070
1224
|
*/
|
|
1071
1225
|
export interface BatchCreateDelegationByAssessmentRequest {
|
|
1072
1226
|
/**
|
|
1227
|
+
* @public
|
|
1073
1228
|
* <p> The API request to batch create delegations in Audit Manager. </p>
|
|
1074
1229
|
*/
|
|
1075
1230
|
createDelegationRequests: CreateDelegationRequest[] | undefined;
|
|
1076
1231
|
/**
|
|
1232
|
+
* @public
|
|
1077
1233
|
* <p> The identifier for the assessment. </p>
|
|
1078
1234
|
*/
|
|
1079
1235
|
assessmentId: string | undefined;
|
|
@@ -1085,15 +1241,18 @@ export interface BatchCreateDelegationByAssessmentRequest {
|
|
|
1085
1241
|
*/
|
|
1086
1242
|
export interface BatchCreateDelegationByAssessmentError {
|
|
1087
1243
|
/**
|
|
1244
|
+
* @public
|
|
1088
1245
|
* <p> The API request to batch create delegations in Audit Manager. </p>
|
|
1089
1246
|
*/
|
|
1090
1247
|
createDelegationRequest?: CreateDelegationRequest;
|
|
1091
1248
|
/**
|
|
1249
|
+
* @public
|
|
1092
1250
|
* <p> The error code that the <code>BatchCreateDelegationByAssessment</code> API returned.
|
|
1093
1251
|
* </p>
|
|
1094
1252
|
*/
|
|
1095
1253
|
errorCode?: string;
|
|
1096
1254
|
/**
|
|
1255
|
+
* @public
|
|
1097
1256
|
* <p> The error message that the <code>BatchCreateDelegationByAssessment</code> API returned.
|
|
1098
1257
|
* </p>
|
|
1099
1258
|
*/
|
|
@@ -1104,10 +1263,12 @@ export interface BatchCreateDelegationByAssessmentError {
|
|
|
1104
1263
|
*/
|
|
1105
1264
|
export interface BatchCreateDelegationByAssessmentResponse {
|
|
1106
1265
|
/**
|
|
1266
|
+
* @public
|
|
1107
1267
|
* <p> The delegations that are associated with the assessment. </p>
|
|
1108
1268
|
*/
|
|
1109
1269
|
delegations?: Delegation[];
|
|
1110
1270
|
/**
|
|
1271
|
+
* @public
|
|
1111
1272
|
* <p> A list of errors that the <code>BatchCreateDelegationByAssessment</code> API returned.
|
|
1112
1273
|
* </p>
|
|
1113
1274
|
*/
|
|
@@ -1118,10 +1279,12 @@ export interface BatchCreateDelegationByAssessmentResponse {
|
|
|
1118
1279
|
*/
|
|
1119
1280
|
export interface BatchDeleteDelegationByAssessmentRequest {
|
|
1120
1281
|
/**
|
|
1282
|
+
* @public
|
|
1121
1283
|
* <p> The identifiers for the delegations. </p>
|
|
1122
1284
|
*/
|
|
1123
1285
|
delegationIds: string[] | undefined;
|
|
1124
1286
|
/**
|
|
1287
|
+
* @public
|
|
1125
1288
|
* <p> The identifier for the assessment. </p>
|
|
1126
1289
|
*/
|
|
1127
1290
|
assessmentId: string | undefined;
|
|
@@ -1133,15 +1296,18 @@ export interface BatchDeleteDelegationByAssessmentRequest {
|
|
|
1133
1296
|
*/
|
|
1134
1297
|
export interface BatchDeleteDelegationByAssessmentError {
|
|
1135
1298
|
/**
|
|
1299
|
+
* @public
|
|
1136
1300
|
* <p> The identifier for the delegation. </p>
|
|
1137
1301
|
*/
|
|
1138
1302
|
delegationId?: string;
|
|
1139
1303
|
/**
|
|
1304
|
+
* @public
|
|
1140
1305
|
* <p> The error code that the <code>BatchDeleteDelegationByAssessment</code> API returned.
|
|
1141
1306
|
* </p>
|
|
1142
1307
|
*/
|
|
1143
1308
|
errorCode?: string;
|
|
1144
1309
|
/**
|
|
1310
|
+
* @public
|
|
1145
1311
|
* <p> The error message that the <code>BatchDeleteDelegationByAssessment</code> API returned.
|
|
1146
1312
|
* </p>
|
|
1147
1313
|
*/
|
|
@@ -1152,6 +1318,7 @@ export interface BatchDeleteDelegationByAssessmentError {
|
|
|
1152
1318
|
*/
|
|
1153
1319
|
export interface BatchDeleteDelegationByAssessmentResponse {
|
|
1154
1320
|
/**
|
|
1321
|
+
* @public
|
|
1155
1322
|
* <p> A list of errors that the <code>BatchDeleteDelegationByAssessment</code> API returned.
|
|
1156
1323
|
* </p>
|
|
1157
1324
|
*/
|
|
@@ -1162,14 +1329,17 @@ export interface BatchDeleteDelegationByAssessmentResponse {
|
|
|
1162
1329
|
*/
|
|
1163
1330
|
export interface BatchDisassociateAssessmentReportEvidenceRequest {
|
|
1164
1331
|
/**
|
|
1332
|
+
* @public
|
|
1165
1333
|
* <p> The identifier for the assessment. </p>
|
|
1166
1334
|
*/
|
|
1167
1335
|
assessmentId: string | undefined;
|
|
1168
1336
|
/**
|
|
1337
|
+
* @public
|
|
1169
1338
|
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
1170
1339
|
*/
|
|
1171
1340
|
evidenceFolderId: string | undefined;
|
|
1172
1341
|
/**
|
|
1342
|
+
* @public
|
|
1173
1343
|
* <p> The list of evidence identifiers. </p>
|
|
1174
1344
|
*/
|
|
1175
1345
|
evidenceIds: string[] | undefined;
|
|
@@ -1179,10 +1349,12 @@ export interface BatchDisassociateAssessmentReportEvidenceRequest {
|
|
|
1179
1349
|
*/
|
|
1180
1350
|
export interface BatchDisassociateAssessmentReportEvidenceResponse {
|
|
1181
1351
|
/**
|
|
1352
|
+
* @public
|
|
1182
1353
|
* <p> The identifier for the evidence. </p>
|
|
1183
1354
|
*/
|
|
1184
1355
|
evidenceIds?: string[];
|
|
1185
1356
|
/**
|
|
1357
|
+
* @public
|
|
1186
1358
|
* <p> A list of errors that the <code>BatchDisassociateAssessmentReportEvidence</code> API
|
|
1187
1359
|
* returned. </p>
|
|
1188
1360
|
*/
|
|
@@ -1196,14 +1368,17 @@ export interface BatchDisassociateAssessmentReportEvidenceResponse {
|
|
|
1196
1368
|
*/
|
|
1197
1369
|
export interface ManualEvidence {
|
|
1198
1370
|
/**
|
|
1371
|
+
* @public
|
|
1199
1372
|
* <p>The S3 URL of the object that's imported as manual evidence. </p>
|
|
1200
1373
|
*/
|
|
1201
1374
|
s3ResourcePath?: string;
|
|
1202
1375
|
/**
|
|
1376
|
+
* @public
|
|
1203
1377
|
* <p>The plain text response that's entered and saved as manual evidence.</p>
|
|
1204
1378
|
*/
|
|
1205
1379
|
textResponse?: string;
|
|
1206
1380
|
/**
|
|
1381
|
+
* @public
|
|
1207
1382
|
* <p>The name of the file that's uploaded as manual evidence. This name is populated using
|
|
1208
1383
|
* the <code>evidenceFileName</code> value from the <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_GetEvidenceFileUploadUrl.html">
|
|
1209
1384
|
* <code>GetEvidenceFileUploadUrl</code>
|
|
@@ -1216,18 +1391,22 @@ export interface ManualEvidence {
|
|
|
1216
1391
|
*/
|
|
1217
1392
|
export interface BatchImportEvidenceToAssessmentControlRequest {
|
|
1218
1393
|
/**
|
|
1394
|
+
* @public
|
|
1219
1395
|
* <p> The identifier for the assessment. </p>
|
|
1220
1396
|
*/
|
|
1221
1397
|
assessmentId: string | undefined;
|
|
1222
1398
|
/**
|
|
1399
|
+
* @public
|
|
1223
1400
|
* <p> The identifier for the control set. </p>
|
|
1224
1401
|
*/
|
|
1225
1402
|
controlSetId: string | undefined;
|
|
1226
1403
|
/**
|
|
1404
|
+
* @public
|
|
1227
1405
|
* <p> The identifier for the control. </p>
|
|
1228
1406
|
*/
|
|
1229
1407
|
controlId: string | undefined;
|
|
1230
1408
|
/**
|
|
1409
|
+
* @public
|
|
1231
1410
|
* <p> The list of manual evidence objects. </p>
|
|
1232
1411
|
*/
|
|
1233
1412
|
manualEvidence: ManualEvidence[] | undefined;
|
|
@@ -1239,15 +1418,18 @@ export interface BatchImportEvidenceToAssessmentControlRequest {
|
|
|
1239
1418
|
*/
|
|
1240
1419
|
export interface BatchImportEvidenceToAssessmentControlError {
|
|
1241
1420
|
/**
|
|
1421
|
+
* @public
|
|
1242
1422
|
* <p> Manual evidence that can't be collected automatically by Audit Manager. </p>
|
|
1243
1423
|
*/
|
|
1244
1424
|
manualEvidence?: ManualEvidence;
|
|
1245
1425
|
/**
|
|
1426
|
+
* @public
|
|
1246
1427
|
* <p> The error code that the <code>BatchImportEvidenceToAssessmentControl</code> API
|
|
1247
1428
|
* returned. </p>
|
|
1248
1429
|
*/
|
|
1249
1430
|
errorCode?: string;
|
|
1250
1431
|
/**
|
|
1432
|
+
* @public
|
|
1251
1433
|
* <p> The error message that the <code>BatchImportEvidenceToAssessmentControl</code> API
|
|
1252
1434
|
* returned. </p>
|
|
1253
1435
|
*/
|
|
@@ -1258,6 +1440,7 @@ export interface BatchImportEvidenceToAssessmentControlError {
|
|
|
1258
1440
|
*/
|
|
1259
1441
|
export interface BatchImportEvidenceToAssessmentControlResponse {
|
|
1260
1442
|
/**
|
|
1443
|
+
* @public
|
|
1261
1444
|
* <p> A list of errors that the <code>BatchImportEvidenceToAssessmentControl</code> API
|
|
1262
1445
|
* returned. </p>
|
|
1263
1446
|
*/
|
|
@@ -1280,32 +1463,39 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1280
1463
|
*/
|
|
1281
1464
|
export interface CreateAssessmentRequest {
|
|
1282
1465
|
/**
|
|
1466
|
+
* @public
|
|
1283
1467
|
* <p> The name of the assessment to be created. </p>
|
|
1284
1468
|
*/
|
|
1285
1469
|
name: string | undefined;
|
|
1286
1470
|
/**
|
|
1471
|
+
* @public
|
|
1287
1472
|
* <p> The optional description of the assessment to be created. </p>
|
|
1288
1473
|
*/
|
|
1289
1474
|
description?: string;
|
|
1290
1475
|
/**
|
|
1476
|
+
* @public
|
|
1291
1477
|
* <p> The assessment report storage destination for the assessment that's being created.
|
|
1292
1478
|
* </p>
|
|
1293
1479
|
*/
|
|
1294
1480
|
assessmentReportsDestination: AssessmentReportsDestination | undefined;
|
|
1295
1481
|
/**
|
|
1482
|
+
* @public
|
|
1296
1483
|
* <p> The wrapper that contains the Amazon Web Services accounts and services that are in
|
|
1297
1484
|
* scope for the assessment. </p>
|
|
1298
1485
|
*/
|
|
1299
1486
|
scope: Scope | undefined;
|
|
1300
1487
|
/**
|
|
1488
|
+
* @public
|
|
1301
1489
|
* <p> The list of roles for the assessment. </p>
|
|
1302
1490
|
*/
|
|
1303
1491
|
roles: Role[] | undefined;
|
|
1304
1492
|
/**
|
|
1493
|
+
* @public
|
|
1305
1494
|
* <p> The identifier for the framework that the assessment will be created from. </p>
|
|
1306
1495
|
*/
|
|
1307
1496
|
frameworkId: string | undefined;
|
|
1308
1497
|
/**
|
|
1498
|
+
* @public
|
|
1309
1499
|
* <p> The tags that are associated with the assessment. </p>
|
|
1310
1500
|
*/
|
|
1311
1501
|
tags?: Record<string, string>;
|
|
@@ -1315,6 +1505,7 @@ export interface CreateAssessmentRequest {
|
|
|
1315
1505
|
*/
|
|
1316
1506
|
export interface CreateAssessmentResponse {
|
|
1317
1507
|
/**
|
|
1508
|
+
* @public
|
|
1318
1509
|
* <p> An entity that defines the scope of audit evidence collected by Audit Manager.
|
|
1319
1510
|
* An Audit Manager assessment is an implementation of an Audit Manager framework. </p>
|
|
1320
1511
|
*/
|
|
@@ -1342,6 +1533,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
1342
1533
|
*/
|
|
1343
1534
|
export interface CreateAssessmentFrameworkControl {
|
|
1344
1535
|
/**
|
|
1536
|
+
* @public
|
|
1345
1537
|
* <p> The unique identifier of the control. </p>
|
|
1346
1538
|
*/
|
|
1347
1539
|
id: string | undefined;
|
|
@@ -1352,10 +1544,12 @@ export interface CreateAssessmentFrameworkControl {
|
|
|
1352
1544
|
*/
|
|
1353
1545
|
export interface CreateAssessmentFrameworkControlSet {
|
|
1354
1546
|
/**
|
|
1547
|
+
* @public
|
|
1355
1548
|
* <p> The name of the control set. </p>
|
|
1356
1549
|
*/
|
|
1357
1550
|
name: string | undefined;
|
|
1358
1551
|
/**
|
|
1552
|
+
* @public
|
|
1359
1553
|
* <p> The list of controls within the control set. This doesn't contain the control set ID.
|
|
1360
1554
|
* </p>
|
|
1361
1555
|
*/
|
|
@@ -1366,23 +1560,28 @@ export interface CreateAssessmentFrameworkControlSet {
|
|
|
1366
1560
|
*/
|
|
1367
1561
|
export interface CreateAssessmentFrameworkRequest {
|
|
1368
1562
|
/**
|
|
1563
|
+
* @public
|
|
1369
1564
|
* <p> The name of the new custom framework. </p>
|
|
1370
1565
|
*/
|
|
1371
1566
|
name: string | undefined;
|
|
1372
1567
|
/**
|
|
1568
|
+
* @public
|
|
1373
1569
|
* <p> An optional description for the new custom framework. </p>
|
|
1374
1570
|
*/
|
|
1375
1571
|
description?: string;
|
|
1376
1572
|
/**
|
|
1573
|
+
* @public
|
|
1377
1574
|
* <p> The compliance type that the new custom framework supports, such as CIS or HIPAA.
|
|
1378
1575
|
* </p>
|
|
1379
1576
|
*/
|
|
1380
1577
|
complianceType?: string;
|
|
1381
1578
|
/**
|
|
1579
|
+
* @public
|
|
1382
1580
|
* <p> The control sets that are associated with the framework. </p>
|
|
1383
1581
|
*/
|
|
1384
1582
|
controlSets: CreateAssessmentFrameworkControlSet[] | undefined;
|
|
1385
1583
|
/**
|
|
1584
|
+
* @public
|
|
1386
1585
|
* <p> The tags that are associated with the framework. </p>
|
|
1387
1586
|
*/
|
|
1388
1587
|
tags?: Record<string, string>;
|
|
@@ -1449,6 +1648,7 @@ export type KeywordInputType = (typeof KeywordInputType)[keyof typeof KeywordInp
|
|
|
1449
1648
|
*/
|
|
1450
1649
|
export interface SourceKeyword {
|
|
1451
1650
|
/**
|
|
1651
|
+
* @public
|
|
1452
1652
|
* <p> The input method for the keyword. </p>
|
|
1453
1653
|
* <ul>
|
|
1454
1654
|
* <li>
|
|
@@ -1482,6 +1682,7 @@ export interface SourceKeyword {
|
|
|
1482
1682
|
*/
|
|
1483
1683
|
keywordInputType?: KeywordInputType | string;
|
|
1484
1684
|
/**
|
|
1685
|
+
* @public
|
|
1485
1686
|
* <p> The value of the keyword that's used when mapping a control data source. For example,
|
|
1486
1687
|
* this can be a CloudTrail event name, a rule name for Config, a
|
|
1487
1688
|
* Security Hub control, or the name of an Amazon Web Services API call. </p>
|
|
@@ -1625,27 +1826,33 @@ export type SourceType = (typeof SourceType)[keyof typeof SourceType];
|
|
|
1625
1826
|
*/
|
|
1626
1827
|
export interface ControlMappingSource {
|
|
1627
1828
|
/**
|
|
1829
|
+
* @public
|
|
1628
1830
|
* <p> The unique identifier for the source. </p>
|
|
1629
1831
|
*/
|
|
1630
1832
|
sourceId?: string;
|
|
1631
1833
|
/**
|
|
1834
|
+
* @public
|
|
1632
1835
|
* <p> The name of the source. </p>
|
|
1633
1836
|
*/
|
|
1634
1837
|
sourceName?: string;
|
|
1635
1838
|
/**
|
|
1839
|
+
* @public
|
|
1636
1840
|
* <p> The description of the source. </p>
|
|
1637
1841
|
*/
|
|
1638
1842
|
sourceDescription?: string;
|
|
1639
1843
|
/**
|
|
1844
|
+
* @public
|
|
1640
1845
|
* <p> The setup option for the data source. This option reflects if the evidence collection
|
|
1641
1846
|
* is automated or manual. </p>
|
|
1642
1847
|
*/
|
|
1643
1848
|
sourceSetUpOption?: SourceSetUpOption | string;
|
|
1644
1849
|
/**
|
|
1850
|
+
* @public
|
|
1645
1851
|
* <p> Specifies one of the five data source types for evidence collection. </p>
|
|
1646
1852
|
*/
|
|
1647
1853
|
sourceType?: SourceType | string;
|
|
1648
1854
|
/**
|
|
1855
|
+
* @public
|
|
1649
1856
|
* <p>A keyword that relates to the control data source.</p>
|
|
1650
1857
|
* <p>For manual evidence, this keyword indicates if the manual evidence is a file or
|
|
1651
1858
|
* text.</p>
|
|
@@ -1680,10 +1887,12 @@ export interface ControlMappingSource {
|
|
|
1680
1887
|
*/
|
|
1681
1888
|
sourceKeyword?: SourceKeyword;
|
|
1682
1889
|
/**
|
|
1890
|
+
* @public
|
|
1683
1891
|
* <p>Specifies how often evidence is collected from the control mapping source. </p>
|
|
1684
1892
|
*/
|
|
1685
1893
|
sourceFrequency?: SourceFrequency | string;
|
|
1686
1894
|
/**
|
|
1895
|
+
* @public
|
|
1687
1896
|
* <p> The instructions for troubleshooting the control. </p>
|
|
1688
1897
|
*/
|
|
1689
1898
|
troubleshootingText?: string;
|
|
@@ -1706,64 +1915,79 @@ export type ControlType = (typeof ControlType)[keyof typeof ControlType];
|
|
|
1706
1915
|
*/
|
|
1707
1916
|
export interface Control {
|
|
1708
1917
|
/**
|
|
1918
|
+
* @public
|
|
1709
1919
|
* <p> The Amazon Resource Name (ARN) of the control. </p>
|
|
1710
1920
|
*/
|
|
1711
1921
|
arn?: string;
|
|
1712
1922
|
/**
|
|
1923
|
+
* @public
|
|
1713
1924
|
* <p> The unique identifier for the control. </p>
|
|
1714
1925
|
*/
|
|
1715
1926
|
id?: string;
|
|
1716
1927
|
/**
|
|
1928
|
+
* @public
|
|
1717
1929
|
* <p> Specifies whether the control is a standard control or a custom control.</p>
|
|
1718
1930
|
*/
|
|
1719
1931
|
type?: ControlType | string;
|
|
1720
1932
|
/**
|
|
1933
|
+
* @public
|
|
1721
1934
|
* <p> The name of the control. </p>
|
|
1722
1935
|
*/
|
|
1723
1936
|
name?: string;
|
|
1724
1937
|
/**
|
|
1938
|
+
* @public
|
|
1725
1939
|
* <p> The description of the control. </p>
|
|
1726
1940
|
*/
|
|
1727
1941
|
description?: string;
|
|
1728
1942
|
/**
|
|
1943
|
+
* @public
|
|
1729
1944
|
* <p> The steps that you should follow to determine if the control has been satisfied.
|
|
1730
1945
|
* </p>
|
|
1731
1946
|
*/
|
|
1732
1947
|
testingInformation?: string;
|
|
1733
1948
|
/**
|
|
1949
|
+
* @public
|
|
1734
1950
|
* <p> The title of the action plan for remediating the control. </p>
|
|
1735
1951
|
*/
|
|
1736
1952
|
actionPlanTitle?: string;
|
|
1737
1953
|
/**
|
|
1954
|
+
* @public
|
|
1738
1955
|
* <p> The recommended actions to carry out if the control isn't fulfilled. </p>
|
|
1739
1956
|
*/
|
|
1740
1957
|
actionPlanInstructions?: string;
|
|
1741
1958
|
/**
|
|
1959
|
+
* @public
|
|
1742
1960
|
* <p> The data source types that determine where Audit Manager collects evidence from for
|
|
1743
1961
|
* the control. </p>
|
|
1744
1962
|
*/
|
|
1745
1963
|
controlSources?: string;
|
|
1746
1964
|
/**
|
|
1965
|
+
* @public
|
|
1747
1966
|
* <p> The data mapping sources for the control. </p>
|
|
1748
1967
|
*/
|
|
1749
1968
|
controlMappingSources?: ControlMappingSource[];
|
|
1750
1969
|
/**
|
|
1970
|
+
* @public
|
|
1751
1971
|
* <p> The time when the control was created. </p>
|
|
1752
1972
|
*/
|
|
1753
1973
|
createdAt?: Date;
|
|
1754
1974
|
/**
|
|
1975
|
+
* @public
|
|
1755
1976
|
* <p> The time when the control was most recently updated. </p>
|
|
1756
1977
|
*/
|
|
1757
1978
|
lastUpdatedAt?: Date;
|
|
1758
1979
|
/**
|
|
1980
|
+
* @public
|
|
1759
1981
|
* <p> The user or role that created the control. </p>
|
|
1760
1982
|
*/
|
|
1761
1983
|
createdBy?: string;
|
|
1762
1984
|
/**
|
|
1985
|
+
* @public
|
|
1763
1986
|
* <p> The user or role that most recently updated the control. </p>
|
|
1764
1987
|
*/
|
|
1765
1988
|
lastUpdatedBy?: string;
|
|
1766
1989
|
/**
|
|
1990
|
+
* @public
|
|
1767
1991
|
* <p> The tags associated with the control. </p>
|
|
1768
1992
|
*/
|
|
1769
1993
|
tags?: Record<string, string>;
|
|
@@ -1774,15 +1998,18 @@ export interface Control {
|
|
|
1774
1998
|
*/
|
|
1775
1999
|
export interface ControlSet {
|
|
1776
2000
|
/**
|
|
2001
|
+
* @public
|
|
1777
2002
|
* <p> The identifier of the control set in the assessment. This is the control set name in a
|
|
1778
2003
|
* plain string format. </p>
|
|
1779
2004
|
*/
|
|
1780
2005
|
id?: string;
|
|
1781
2006
|
/**
|
|
2007
|
+
* @public
|
|
1782
2008
|
* <p> The name of the control set. </p>
|
|
1783
2009
|
*/
|
|
1784
2010
|
name?: string;
|
|
1785
2011
|
/**
|
|
2012
|
+
* @public
|
|
1786
2013
|
* <p> The list of controls within the control set. </p>
|
|
1787
2014
|
*/
|
|
1788
2015
|
controls?: Control[];
|
|
@@ -1794,58 +2021,72 @@ export interface ControlSet {
|
|
|
1794
2021
|
*/
|
|
1795
2022
|
export interface Framework {
|
|
1796
2023
|
/**
|
|
2024
|
+
* @public
|
|
1797
2025
|
* <p> The Amazon Resource Name (ARN) of the framework. </p>
|
|
1798
2026
|
*/
|
|
1799
2027
|
arn?: string;
|
|
1800
2028
|
/**
|
|
2029
|
+
* @public
|
|
1801
2030
|
* <p> The unique identifier for the framework. </p>
|
|
1802
2031
|
*/
|
|
1803
2032
|
id?: string;
|
|
1804
2033
|
/**
|
|
2034
|
+
* @public
|
|
1805
2035
|
* <p> The name of the framework. </p>
|
|
1806
2036
|
*/
|
|
1807
2037
|
name?: string;
|
|
1808
2038
|
/**
|
|
2039
|
+
* @public
|
|
1809
2040
|
* <p> Specifies whether the framework is a standard framework or a custom framework.</p>
|
|
1810
2041
|
*/
|
|
1811
2042
|
type?: FrameworkType | string;
|
|
1812
2043
|
/**
|
|
2044
|
+
* @public
|
|
1813
2045
|
* <p> The compliance type that the framework supports, such as CIS or HIPAA. </p>
|
|
1814
2046
|
*/
|
|
1815
2047
|
complianceType?: string;
|
|
1816
2048
|
/**
|
|
2049
|
+
* @public
|
|
1817
2050
|
* <p> The description of the framework. </p>
|
|
1818
2051
|
*/
|
|
1819
2052
|
description?: string;
|
|
1820
2053
|
/**
|
|
2054
|
+
* @public
|
|
1821
2055
|
* <p> The logo that's associated with the framework. </p>
|
|
1822
2056
|
*/
|
|
1823
2057
|
logo?: string;
|
|
1824
2058
|
/**
|
|
2059
|
+
* @public
|
|
1825
2060
|
* <p> The control data sources where Audit Manager collects evidence from.</p>
|
|
1826
2061
|
*/
|
|
1827
2062
|
controlSources?: string;
|
|
1828
2063
|
/**
|
|
2064
|
+
* @public
|
|
1829
2065
|
* <p> The control sets that are associated with the framework. </p>
|
|
1830
2066
|
*/
|
|
1831
2067
|
controlSets?: ControlSet[];
|
|
1832
2068
|
/**
|
|
2069
|
+
* @public
|
|
1833
2070
|
* <p> The time when the framework was created. </p>
|
|
1834
2071
|
*/
|
|
1835
2072
|
createdAt?: Date;
|
|
1836
2073
|
/**
|
|
2074
|
+
* @public
|
|
1837
2075
|
* <p> The time when the framework was most recently updated. </p>
|
|
1838
2076
|
*/
|
|
1839
2077
|
lastUpdatedAt?: Date;
|
|
1840
2078
|
/**
|
|
2079
|
+
* @public
|
|
1841
2080
|
* <p> The user or role that created the framework. </p>
|
|
1842
2081
|
*/
|
|
1843
2082
|
createdBy?: string;
|
|
1844
2083
|
/**
|
|
2084
|
+
* @public
|
|
1845
2085
|
* <p> The user or role that most recently updated the framework. </p>
|
|
1846
2086
|
*/
|
|
1847
2087
|
lastUpdatedBy?: string;
|
|
1848
2088
|
/**
|
|
2089
|
+
* @public
|
|
1849
2090
|
* <p> The tags that are associated with the framework. </p>
|
|
1850
2091
|
*/
|
|
1851
2092
|
tags?: Record<string, string>;
|
|
@@ -1855,6 +2096,7 @@ export interface Framework {
|
|
|
1855
2096
|
*/
|
|
1856
2097
|
export interface CreateAssessmentFrameworkResponse {
|
|
1857
2098
|
/**
|
|
2099
|
+
* @public
|
|
1858
2100
|
* <p> The name of the new framework that the <code>CreateAssessmentFramework</code> API
|
|
1859
2101
|
* returned. </p>
|
|
1860
2102
|
*/
|
|
@@ -1865,18 +2107,22 @@ export interface CreateAssessmentFrameworkResponse {
|
|
|
1865
2107
|
*/
|
|
1866
2108
|
export interface CreateAssessmentReportRequest {
|
|
1867
2109
|
/**
|
|
2110
|
+
* @public
|
|
1868
2111
|
* <p> The name of the new assessment report. </p>
|
|
1869
2112
|
*/
|
|
1870
2113
|
name: string | undefined;
|
|
1871
2114
|
/**
|
|
2115
|
+
* @public
|
|
1872
2116
|
* <p> The description of the assessment report. </p>
|
|
1873
2117
|
*/
|
|
1874
2118
|
description?: string;
|
|
1875
2119
|
/**
|
|
2120
|
+
* @public
|
|
1876
2121
|
* <p> The identifier for the assessment. </p>
|
|
1877
2122
|
*/
|
|
1878
2123
|
assessmentId: string | undefined;
|
|
1879
2124
|
/**
|
|
2125
|
+
* @public
|
|
1880
2126
|
* <p>A SQL statement that represents an evidence finder query.</p>
|
|
1881
2127
|
* <p>Provide this parameter when you want to generate an assessment report from the results
|
|
1882
2128
|
* of an evidence finder search query. When you use this parameter, Audit Manager
|
|
@@ -1895,6 +2141,7 @@ export interface CreateAssessmentReportRequest {
|
|
|
1895
2141
|
*/
|
|
1896
2142
|
export interface CreateAssessmentReportResponse {
|
|
1897
2143
|
/**
|
|
2144
|
+
* @public
|
|
1898
2145
|
* <p> The new assessment report that the <code>CreateAssessmentReport</code> API returned.
|
|
1899
2146
|
* </p>
|
|
1900
2147
|
*/
|
|
@@ -1907,24 +2154,29 @@ export interface CreateAssessmentReportResponse {
|
|
|
1907
2154
|
*/
|
|
1908
2155
|
export interface CreateControlMappingSource {
|
|
1909
2156
|
/**
|
|
2157
|
+
* @public
|
|
1910
2158
|
* <p> The name of the control mapping data source. </p>
|
|
1911
2159
|
*/
|
|
1912
2160
|
sourceName?: string;
|
|
1913
2161
|
/**
|
|
2162
|
+
* @public
|
|
1914
2163
|
* <p> The description of the data source that determines where Audit Manager collects
|
|
1915
2164
|
* evidence from for the control. </p>
|
|
1916
2165
|
*/
|
|
1917
2166
|
sourceDescription?: string;
|
|
1918
2167
|
/**
|
|
2168
|
+
* @public
|
|
1919
2169
|
* <p> The setup option for the data source, which reflects if the evidence collection is
|
|
1920
2170
|
* automated or manual. </p>
|
|
1921
2171
|
*/
|
|
1922
2172
|
sourceSetUpOption?: SourceSetUpOption | string;
|
|
1923
2173
|
/**
|
|
2174
|
+
* @public
|
|
1924
2175
|
* <p> Specifies one of the five types of data sources for evidence collection. </p>
|
|
1925
2176
|
*/
|
|
1926
2177
|
sourceType?: SourceType | string;
|
|
1927
2178
|
/**
|
|
2179
|
+
* @public
|
|
1928
2180
|
* <p>A keyword that relates to the control data source.</p>
|
|
1929
2181
|
* <p>For manual evidence, this keyword indicates if the manual evidence is a file or
|
|
1930
2182
|
* text.</p>
|
|
@@ -1959,10 +2211,12 @@ export interface CreateControlMappingSource {
|
|
|
1959
2211
|
*/
|
|
1960
2212
|
sourceKeyword?: SourceKeyword;
|
|
1961
2213
|
/**
|
|
2214
|
+
* @public
|
|
1962
2215
|
* <p>Specifies how often evidence is collected from the control mapping source. </p>
|
|
1963
2216
|
*/
|
|
1964
2217
|
sourceFrequency?: SourceFrequency | string;
|
|
1965
2218
|
/**
|
|
2219
|
+
* @public
|
|
1966
2220
|
* <p> The instructions for troubleshooting the control. </p>
|
|
1967
2221
|
*/
|
|
1968
2222
|
troubleshootingText?: string;
|
|
@@ -1972,30 +2226,37 @@ export interface CreateControlMappingSource {
|
|
|
1972
2226
|
*/
|
|
1973
2227
|
export interface CreateControlRequest {
|
|
1974
2228
|
/**
|
|
2229
|
+
* @public
|
|
1975
2230
|
* <p> The name of the control. </p>
|
|
1976
2231
|
*/
|
|
1977
2232
|
name: string | undefined;
|
|
1978
2233
|
/**
|
|
2234
|
+
* @public
|
|
1979
2235
|
* <p> The description of the control. </p>
|
|
1980
2236
|
*/
|
|
1981
2237
|
description?: string;
|
|
1982
2238
|
/**
|
|
2239
|
+
* @public
|
|
1983
2240
|
* <p> The steps to follow to determine if the control is satisfied. </p>
|
|
1984
2241
|
*/
|
|
1985
2242
|
testingInformation?: string;
|
|
1986
2243
|
/**
|
|
2244
|
+
* @public
|
|
1987
2245
|
* <p> The title of the action plan for remediating the control. </p>
|
|
1988
2246
|
*/
|
|
1989
2247
|
actionPlanTitle?: string;
|
|
1990
2248
|
/**
|
|
2249
|
+
* @public
|
|
1991
2250
|
* <p> The recommended actions to carry out if the control isn't fulfilled. </p>
|
|
1992
2251
|
*/
|
|
1993
2252
|
actionPlanInstructions?: string;
|
|
1994
2253
|
/**
|
|
2254
|
+
* @public
|
|
1995
2255
|
* <p> The data mapping sources for the control. </p>
|
|
1996
2256
|
*/
|
|
1997
2257
|
controlMappingSources: CreateControlMappingSource[] | undefined;
|
|
1998
2258
|
/**
|
|
2259
|
+
* @public
|
|
1999
2260
|
* <p> The tags that are associated with the control. </p>
|
|
2000
2261
|
*/
|
|
2001
2262
|
tags?: Record<string, string>;
|
|
@@ -2005,6 +2266,7 @@ export interface CreateControlRequest {
|
|
|
2005
2266
|
*/
|
|
2006
2267
|
export interface CreateControlResponse {
|
|
2007
2268
|
/**
|
|
2269
|
+
* @public
|
|
2008
2270
|
* <p> The new control that the <code>CreateControl</code> API returned. </p>
|
|
2009
2271
|
*/
|
|
2010
2272
|
control?: Control;
|
|
@@ -2014,6 +2276,7 @@ export interface CreateControlResponse {
|
|
|
2014
2276
|
*/
|
|
2015
2277
|
export interface DeleteAssessmentRequest {
|
|
2016
2278
|
/**
|
|
2279
|
+
* @public
|
|
2017
2280
|
* <p> The identifier for the assessment. </p>
|
|
2018
2281
|
*/
|
|
2019
2282
|
assessmentId: string | undefined;
|
|
@@ -2028,6 +2291,7 @@ export interface DeleteAssessmentResponse {
|
|
|
2028
2291
|
*/
|
|
2029
2292
|
export interface DeleteAssessmentFrameworkRequest {
|
|
2030
2293
|
/**
|
|
2294
|
+
* @public
|
|
2031
2295
|
* <p> The identifier for the custom framework. </p>
|
|
2032
2296
|
*/
|
|
2033
2297
|
frameworkId: string | undefined;
|
|
@@ -2054,10 +2318,12 @@ export type ShareRequestType = (typeof ShareRequestType)[keyof typeof ShareReque
|
|
|
2054
2318
|
*/
|
|
2055
2319
|
export interface DeleteAssessmentFrameworkShareRequest {
|
|
2056
2320
|
/**
|
|
2321
|
+
* @public
|
|
2057
2322
|
* <p>The unique identifier for the share request to be deleted.</p>
|
|
2058
2323
|
*/
|
|
2059
2324
|
requestId: string | undefined;
|
|
2060
2325
|
/**
|
|
2326
|
+
* @public
|
|
2061
2327
|
* <p>Specifies whether the share request is a sent request or a received request.</p>
|
|
2062
2328
|
*/
|
|
2063
2329
|
requestType: ShareRequestType | string | undefined;
|
|
@@ -2072,10 +2338,12 @@ export interface DeleteAssessmentFrameworkShareResponse {
|
|
|
2072
2338
|
*/
|
|
2073
2339
|
export interface DeleteAssessmentReportRequest {
|
|
2074
2340
|
/**
|
|
2341
|
+
* @public
|
|
2075
2342
|
* <p> The unique identifier for the assessment. </p>
|
|
2076
2343
|
*/
|
|
2077
2344
|
assessmentId: string | undefined;
|
|
2078
2345
|
/**
|
|
2346
|
+
* @public
|
|
2079
2347
|
* <p> The unique identifier for the assessment report. </p>
|
|
2080
2348
|
*/
|
|
2081
2349
|
assessmentReportId: string | undefined;
|
|
@@ -2090,6 +2358,7 @@ export interface DeleteAssessmentReportResponse {
|
|
|
2090
2358
|
*/
|
|
2091
2359
|
export interface DeleteControlRequest {
|
|
2092
2360
|
/**
|
|
2361
|
+
* @public
|
|
2093
2362
|
* <p> The unique identifier for the control. </p>
|
|
2094
2363
|
*/
|
|
2095
2364
|
controlId: string | undefined;
|
|
@@ -2109,6 +2378,7 @@ export interface DeregisterAccountRequest {
|
|
|
2109
2378
|
*/
|
|
2110
2379
|
export interface DeregisterAccountResponse {
|
|
2111
2380
|
/**
|
|
2381
|
+
* @public
|
|
2112
2382
|
* <p> The registration status of the account. </p>
|
|
2113
2383
|
*/
|
|
2114
2384
|
status?: AccountStatus | string;
|
|
@@ -2118,6 +2388,7 @@ export interface DeregisterAccountResponse {
|
|
|
2118
2388
|
*/
|
|
2119
2389
|
export interface DeregisterOrganizationAdminAccountRequest {
|
|
2120
2390
|
/**
|
|
2391
|
+
* @public
|
|
2121
2392
|
* <p> The identifier for the administrator account. </p>
|
|
2122
2393
|
*/
|
|
2123
2394
|
adminAccountId?: string;
|
|
@@ -2132,10 +2403,12 @@ export interface DeregisterOrganizationAdminAccountResponse {
|
|
|
2132
2403
|
*/
|
|
2133
2404
|
export interface DisassociateAssessmentReportEvidenceFolderRequest {
|
|
2134
2405
|
/**
|
|
2406
|
+
* @public
|
|
2135
2407
|
* <p> The unique identifier for the assessment. </p>
|
|
2136
2408
|
*/
|
|
2137
2409
|
assessmentId: string | undefined;
|
|
2138
2410
|
/**
|
|
2411
|
+
* @public
|
|
2139
2412
|
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2140
2413
|
*/
|
|
2141
2414
|
evidenceFolderId: string | undefined;
|
|
@@ -2155,6 +2428,7 @@ export interface GetAccountStatusRequest {
|
|
|
2155
2428
|
*/
|
|
2156
2429
|
export interface GetAccountStatusResponse {
|
|
2157
2430
|
/**
|
|
2431
|
+
* @public
|
|
2158
2432
|
* <p> The status of the Amazon Web Services account. </p>
|
|
2159
2433
|
*/
|
|
2160
2434
|
status?: AccountStatus | string;
|
|
@@ -2164,6 +2438,7 @@ export interface GetAccountStatusResponse {
|
|
|
2164
2438
|
*/
|
|
2165
2439
|
export interface GetAssessmentRequest {
|
|
2166
2440
|
/**
|
|
2441
|
+
* @public
|
|
2167
2442
|
* <p>The unique identifier for the assessment. </p>
|
|
2168
2443
|
*/
|
|
2169
2444
|
assessmentId: string | undefined;
|
|
@@ -2173,11 +2448,13 @@ export interface GetAssessmentRequest {
|
|
|
2173
2448
|
*/
|
|
2174
2449
|
export interface GetAssessmentResponse {
|
|
2175
2450
|
/**
|
|
2451
|
+
* @public
|
|
2176
2452
|
* <p> An entity that defines the scope of audit evidence collected by Audit Manager.
|
|
2177
2453
|
* An Audit Manager assessment is an implementation of an Audit Manager framework. </p>
|
|
2178
2454
|
*/
|
|
2179
2455
|
assessment?: Assessment;
|
|
2180
2456
|
/**
|
|
2457
|
+
* @public
|
|
2181
2458
|
* <p> The wrapper that contains the Audit Manager role information of the current user.
|
|
2182
2459
|
* This includes the role type and IAM Amazon Resource Name (ARN). </p>
|
|
2183
2460
|
*/
|
|
@@ -2188,6 +2465,7 @@ export interface GetAssessmentResponse {
|
|
|
2188
2465
|
*/
|
|
2189
2466
|
export interface GetAssessmentFrameworkRequest {
|
|
2190
2467
|
/**
|
|
2468
|
+
* @public
|
|
2191
2469
|
* <p> The identifier for the framework. </p>
|
|
2192
2470
|
*/
|
|
2193
2471
|
frameworkId: string | undefined;
|
|
@@ -2197,6 +2475,7 @@ export interface GetAssessmentFrameworkRequest {
|
|
|
2197
2475
|
*/
|
|
2198
2476
|
export interface GetAssessmentFrameworkResponse {
|
|
2199
2477
|
/**
|
|
2478
|
+
* @public
|
|
2200
2479
|
* <p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>
|
|
2201
2480
|
*/
|
|
2202
2481
|
framework?: Framework;
|
|
@@ -2206,10 +2485,12 @@ export interface GetAssessmentFrameworkResponse {
|
|
|
2206
2485
|
*/
|
|
2207
2486
|
export interface GetAssessmentReportUrlRequest {
|
|
2208
2487
|
/**
|
|
2488
|
+
* @public
|
|
2209
2489
|
* <p> The unique identifier for the assessment report. </p>
|
|
2210
2490
|
*/
|
|
2211
2491
|
assessmentReportId: string | undefined;
|
|
2212
2492
|
/**
|
|
2493
|
+
* @public
|
|
2213
2494
|
* <p> The unique identifier for the assessment. </p>
|
|
2214
2495
|
*/
|
|
2215
2496
|
assessmentId: string | undefined;
|
|
@@ -2221,10 +2502,12 @@ export interface GetAssessmentReportUrlRequest {
|
|
|
2221
2502
|
*/
|
|
2222
2503
|
export interface URL {
|
|
2223
2504
|
/**
|
|
2505
|
+
* @public
|
|
2224
2506
|
* <p> The name or word that's used as a hyperlink to the URL. </p>
|
|
2225
2507
|
*/
|
|
2226
2508
|
hyperlinkName?: string;
|
|
2227
2509
|
/**
|
|
2510
|
+
* @public
|
|
2228
2511
|
* <p> The unique identifier for the internet resource. </p>
|
|
2229
2512
|
*/
|
|
2230
2513
|
link?: string;
|
|
@@ -2234,6 +2517,7 @@ export interface URL {
|
|
|
2234
2517
|
*/
|
|
2235
2518
|
export interface GetAssessmentReportUrlResponse {
|
|
2236
2519
|
/**
|
|
2520
|
+
* @public
|
|
2237
2521
|
* <p> Short for uniform resource locator. A URL is used as a unique identifier to locate a
|
|
2238
2522
|
* resource on the internet. </p>
|
|
2239
2523
|
*/
|
|
@@ -2244,22 +2528,27 @@ export interface GetAssessmentReportUrlResponse {
|
|
|
2244
2528
|
*/
|
|
2245
2529
|
export interface GetChangeLogsRequest {
|
|
2246
2530
|
/**
|
|
2531
|
+
* @public
|
|
2247
2532
|
* <p>The unique identifier for the assessment. </p>
|
|
2248
2533
|
*/
|
|
2249
2534
|
assessmentId: string | undefined;
|
|
2250
2535
|
/**
|
|
2536
|
+
* @public
|
|
2251
2537
|
* <p> The unique identifier for the control set. </p>
|
|
2252
2538
|
*/
|
|
2253
2539
|
controlSetId?: string;
|
|
2254
2540
|
/**
|
|
2541
|
+
* @public
|
|
2255
2542
|
* <p> The unique identifier for the control. </p>
|
|
2256
2543
|
*/
|
|
2257
2544
|
controlId?: string;
|
|
2258
2545
|
/**
|
|
2546
|
+
* @public
|
|
2259
2547
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2260
2548
|
*/
|
|
2261
2549
|
nextToken?: string;
|
|
2262
2550
|
/**
|
|
2551
|
+
* @public
|
|
2263
2552
|
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
2264
2553
|
*/
|
|
2265
2554
|
maxResults?: number;
|
|
@@ -2286,23 +2575,28 @@ export type ObjectTypeEnum = (typeof ObjectTypeEnum)[keyof typeof ObjectTypeEnum
|
|
|
2286
2575
|
*/
|
|
2287
2576
|
export interface ChangeLog {
|
|
2288
2577
|
/**
|
|
2578
|
+
* @public
|
|
2289
2579
|
* <p> The object that was changed, such as an assessment, control, or control set. </p>
|
|
2290
2580
|
*/
|
|
2291
2581
|
objectType?: ObjectTypeEnum | string;
|
|
2292
2582
|
/**
|
|
2583
|
+
* @public
|
|
2293
2584
|
* <p> The name of the object that changed. This could be the name of an assessment, control,
|
|
2294
2585
|
* or control set.</p>
|
|
2295
2586
|
*/
|
|
2296
2587
|
objectName?: string;
|
|
2297
2588
|
/**
|
|
2589
|
+
* @public
|
|
2298
2590
|
* <p> The action that was performed. </p>
|
|
2299
2591
|
*/
|
|
2300
2592
|
action?: ActionEnum | string;
|
|
2301
2593
|
/**
|
|
2594
|
+
* @public
|
|
2302
2595
|
* <p> The time when the action was performed and the changelog record was created. </p>
|
|
2303
2596
|
*/
|
|
2304
2597
|
createdAt?: Date;
|
|
2305
2598
|
/**
|
|
2599
|
+
* @public
|
|
2306
2600
|
* <p> The user or role that performed the action. </p>
|
|
2307
2601
|
*/
|
|
2308
2602
|
createdBy?: string;
|
|
@@ -2312,10 +2606,12 @@ export interface ChangeLog {
|
|
|
2312
2606
|
*/
|
|
2313
2607
|
export interface GetChangeLogsResponse {
|
|
2314
2608
|
/**
|
|
2609
|
+
* @public
|
|
2315
2610
|
* <p>The list of user activity for the control. </p>
|
|
2316
2611
|
*/
|
|
2317
2612
|
changeLogs?: ChangeLog[];
|
|
2318
2613
|
/**
|
|
2614
|
+
* @public
|
|
2319
2615
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
2320
2616
|
*/
|
|
2321
2617
|
nextToken?: string;
|
|
@@ -2325,6 +2621,7 @@ export interface GetChangeLogsResponse {
|
|
|
2325
2621
|
*/
|
|
2326
2622
|
export interface GetControlRequest {
|
|
2327
2623
|
/**
|
|
2624
|
+
* @public
|
|
2328
2625
|
* <p> The identifier for the control. </p>
|
|
2329
2626
|
*/
|
|
2330
2627
|
controlId: string | undefined;
|
|
@@ -2334,6 +2631,7 @@ export interface GetControlRequest {
|
|
|
2334
2631
|
*/
|
|
2335
2632
|
export interface GetControlResponse {
|
|
2336
2633
|
/**
|
|
2634
|
+
* @public
|
|
2337
2635
|
* <p> The details of the control that the <code>GetControl</code> API returned. </p>
|
|
2338
2636
|
*/
|
|
2339
2637
|
control?: Control;
|
|
@@ -2343,10 +2641,12 @@ export interface GetControlResponse {
|
|
|
2343
2641
|
*/
|
|
2344
2642
|
export interface GetDelegationsRequest {
|
|
2345
2643
|
/**
|
|
2644
|
+
* @public
|
|
2346
2645
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2347
2646
|
*/
|
|
2348
2647
|
nextToken?: string;
|
|
2349
2648
|
/**
|
|
2649
|
+
* @public
|
|
2350
2650
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
2351
2651
|
*/
|
|
2352
2652
|
maxResults?: number;
|
|
@@ -2357,30 +2657,37 @@ export interface GetDelegationsRequest {
|
|
|
2357
2657
|
*/
|
|
2358
2658
|
export interface DelegationMetadata {
|
|
2359
2659
|
/**
|
|
2660
|
+
* @public
|
|
2360
2661
|
* <p> The unique identifier for the delegation. </p>
|
|
2361
2662
|
*/
|
|
2362
2663
|
id?: string;
|
|
2363
2664
|
/**
|
|
2665
|
+
* @public
|
|
2364
2666
|
* <p> The name of the associated assessment. </p>
|
|
2365
2667
|
*/
|
|
2366
2668
|
assessmentName?: string;
|
|
2367
2669
|
/**
|
|
2670
|
+
* @public
|
|
2368
2671
|
* <p> The unique identifier for the assessment. </p>
|
|
2369
2672
|
*/
|
|
2370
2673
|
assessmentId?: string;
|
|
2371
2674
|
/**
|
|
2675
|
+
* @public
|
|
2372
2676
|
* <p> The current status of the delegation. </p>
|
|
2373
2677
|
*/
|
|
2374
2678
|
status?: DelegationStatus | string;
|
|
2375
2679
|
/**
|
|
2680
|
+
* @public
|
|
2376
2681
|
* <p> The Amazon Resource Name (ARN) of the IAM role. </p>
|
|
2377
2682
|
*/
|
|
2378
2683
|
roleArn?: string;
|
|
2379
2684
|
/**
|
|
2685
|
+
* @public
|
|
2380
2686
|
* <p> Specifies when the delegation was created. </p>
|
|
2381
2687
|
*/
|
|
2382
2688
|
creationTime?: Date;
|
|
2383
2689
|
/**
|
|
2690
|
+
* @public
|
|
2384
2691
|
* <p> Specifies the name of the control set that was delegated for review. </p>
|
|
2385
2692
|
*/
|
|
2386
2693
|
controlSetName?: string;
|
|
@@ -2390,10 +2697,12 @@ export interface DelegationMetadata {
|
|
|
2390
2697
|
*/
|
|
2391
2698
|
export interface GetDelegationsResponse {
|
|
2392
2699
|
/**
|
|
2700
|
+
* @public
|
|
2393
2701
|
* <p> The list of delegations that the <code>GetDelegations</code> API returned. </p>
|
|
2394
2702
|
*/
|
|
2395
2703
|
delegations?: DelegationMetadata[];
|
|
2396
2704
|
/**
|
|
2705
|
+
* @public
|
|
2397
2706
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2398
2707
|
*/
|
|
2399
2708
|
nextToken?: string;
|
|
@@ -2403,18 +2712,22 @@ export interface GetDelegationsResponse {
|
|
|
2403
2712
|
*/
|
|
2404
2713
|
export interface GetEvidenceRequest {
|
|
2405
2714
|
/**
|
|
2715
|
+
* @public
|
|
2406
2716
|
* <p> The unique identifier for the assessment. </p>
|
|
2407
2717
|
*/
|
|
2408
2718
|
assessmentId: string | undefined;
|
|
2409
2719
|
/**
|
|
2720
|
+
* @public
|
|
2410
2721
|
* <p> The unique identifier for the control set. </p>
|
|
2411
2722
|
*/
|
|
2412
2723
|
controlSetId: string | undefined;
|
|
2413
2724
|
/**
|
|
2725
|
+
* @public
|
|
2414
2726
|
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2415
2727
|
*/
|
|
2416
2728
|
evidenceFolderId: string | undefined;
|
|
2417
2729
|
/**
|
|
2730
|
+
* @public
|
|
2418
2731
|
* <p> The unique identifier for the evidence. </p>
|
|
2419
2732
|
*/
|
|
2420
2733
|
evidenceId: string | undefined;
|
|
@@ -2425,14 +2738,17 @@ export interface GetEvidenceRequest {
|
|
|
2425
2738
|
*/
|
|
2426
2739
|
export interface Resource {
|
|
2427
2740
|
/**
|
|
2741
|
+
* @public
|
|
2428
2742
|
* <p> The Amazon Resource Name (ARN) for the resource. </p>
|
|
2429
2743
|
*/
|
|
2430
2744
|
arn?: string;
|
|
2431
2745
|
/**
|
|
2746
|
+
* @public
|
|
2432
2747
|
* <p> The value of the resource. </p>
|
|
2433
2748
|
*/
|
|
2434
2749
|
value?: string;
|
|
2435
2750
|
/**
|
|
2751
|
+
* @public
|
|
2436
2752
|
* <p> The evaluation status for a resource that was assessed when collecting compliance check
|
|
2437
2753
|
* evidence. </p>
|
|
2438
2754
|
* <ul>
|
|
@@ -2465,45 +2781,55 @@ export interface Resource {
|
|
|
2465
2781
|
*/
|
|
2466
2782
|
export interface Evidence {
|
|
2467
2783
|
/**
|
|
2784
|
+
* @public
|
|
2468
2785
|
* <p> The data source where the evidence was collected from. </p>
|
|
2469
2786
|
*/
|
|
2470
2787
|
dataSource?: string;
|
|
2471
2788
|
/**
|
|
2789
|
+
* @public
|
|
2472
2790
|
* <p> The identifier for the Amazon Web Services account. </p>
|
|
2473
2791
|
*/
|
|
2474
2792
|
evidenceAwsAccountId?: string;
|
|
2475
2793
|
/**
|
|
2794
|
+
* @public
|
|
2476
2795
|
* <p> The timestamp that represents when the evidence was collected. </p>
|
|
2477
2796
|
*/
|
|
2478
2797
|
time?: Date;
|
|
2479
2798
|
/**
|
|
2799
|
+
* @public
|
|
2480
2800
|
* <p> The Amazon Web Service that the evidence is collected from. </p>
|
|
2481
2801
|
*/
|
|
2482
2802
|
eventSource?: string;
|
|
2483
2803
|
/**
|
|
2804
|
+
* @public
|
|
2484
2805
|
* <p> The name of the evidence event. </p>
|
|
2485
2806
|
*/
|
|
2486
2807
|
eventName?: string;
|
|
2487
2808
|
/**
|
|
2809
|
+
* @public
|
|
2488
2810
|
* <p> The type of automated evidence. </p>
|
|
2489
2811
|
*/
|
|
2490
2812
|
evidenceByType?: string;
|
|
2491
2813
|
/**
|
|
2814
|
+
* @public
|
|
2492
2815
|
* <p> The list of resources that are assessed to generate the evidence. </p>
|
|
2493
2816
|
*/
|
|
2494
2817
|
resourcesIncluded?: Resource[];
|
|
2495
2818
|
/**
|
|
2819
|
+
* @public
|
|
2496
2820
|
* <p> The names and values that are used by the evidence event. This includes an attribute
|
|
2497
2821
|
* name (such as <code>allowUsersToChangePassword</code>) and value (such as <code>true</code>
|
|
2498
2822
|
* or <code>false</code>). </p>
|
|
2499
2823
|
*/
|
|
2500
2824
|
attributes?: Record<string, string>;
|
|
2501
2825
|
/**
|
|
2826
|
+
* @public
|
|
2502
2827
|
* <p> The unique identifier for the user or role that's associated with
|
|
2503
2828
|
* the evidence. </p>
|
|
2504
2829
|
*/
|
|
2505
2830
|
iamId?: string;
|
|
2506
2831
|
/**
|
|
2832
|
+
* @public
|
|
2507
2833
|
* <p>The evaluation status for automated evidence that falls under the compliance check
|
|
2508
2834
|
* category.</p>
|
|
2509
2835
|
* <ul>
|
|
@@ -2529,23 +2855,28 @@ export interface Evidence {
|
|
|
2529
2855
|
*/
|
|
2530
2856
|
complianceCheck?: string;
|
|
2531
2857
|
/**
|
|
2858
|
+
* @public
|
|
2532
2859
|
* <p> The Amazon Web Services account that the evidence is collected from, and its
|
|
2533
2860
|
* organization path. </p>
|
|
2534
2861
|
*/
|
|
2535
2862
|
awsOrganization?: string;
|
|
2536
2863
|
/**
|
|
2864
|
+
* @public
|
|
2537
2865
|
* <p> The identifier for the Amazon Web Services account. </p>
|
|
2538
2866
|
*/
|
|
2539
2867
|
awsAccountId?: string;
|
|
2540
2868
|
/**
|
|
2869
|
+
* @public
|
|
2541
2870
|
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
2542
2871
|
*/
|
|
2543
2872
|
evidenceFolderId?: string;
|
|
2544
2873
|
/**
|
|
2874
|
+
* @public
|
|
2545
2875
|
* <p> The identifier for the evidence. </p>
|
|
2546
2876
|
*/
|
|
2547
2877
|
id?: string;
|
|
2548
2878
|
/**
|
|
2879
|
+
* @public
|
|
2549
2880
|
* <p> Specifies whether the evidence is included in the assessment report. </p>
|
|
2550
2881
|
*/
|
|
2551
2882
|
assessmentReportSelection?: string;
|
|
@@ -2555,6 +2886,7 @@ export interface Evidence {
|
|
|
2555
2886
|
*/
|
|
2556
2887
|
export interface GetEvidenceResponse {
|
|
2557
2888
|
/**
|
|
2889
|
+
* @public
|
|
2558
2890
|
* <p> The evidence that the <code>GetEvidence</code> API returned. </p>
|
|
2559
2891
|
*/
|
|
2560
2892
|
evidence?: Evidence;
|
|
@@ -2564,22 +2896,27 @@ export interface GetEvidenceResponse {
|
|
|
2564
2896
|
*/
|
|
2565
2897
|
export interface GetEvidenceByEvidenceFolderRequest {
|
|
2566
2898
|
/**
|
|
2899
|
+
* @public
|
|
2567
2900
|
* <p> The identifier for the assessment. </p>
|
|
2568
2901
|
*/
|
|
2569
2902
|
assessmentId: string | undefined;
|
|
2570
2903
|
/**
|
|
2904
|
+
* @public
|
|
2571
2905
|
* <p> The identifier for the control set. </p>
|
|
2572
2906
|
*/
|
|
2573
2907
|
controlSetId: string | undefined;
|
|
2574
2908
|
/**
|
|
2909
|
+
* @public
|
|
2575
2910
|
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2576
2911
|
*/
|
|
2577
2912
|
evidenceFolderId: string | undefined;
|
|
2578
2913
|
/**
|
|
2914
|
+
* @public
|
|
2579
2915
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2580
2916
|
*/
|
|
2581
2917
|
nextToken?: string;
|
|
2582
2918
|
/**
|
|
2919
|
+
* @public
|
|
2583
2920
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
2584
2921
|
*/
|
|
2585
2922
|
maxResults?: number;
|
|
@@ -2589,11 +2926,13 @@ export interface GetEvidenceByEvidenceFolderRequest {
|
|
|
2589
2926
|
*/
|
|
2590
2927
|
export interface GetEvidenceByEvidenceFolderResponse {
|
|
2591
2928
|
/**
|
|
2929
|
+
* @public
|
|
2592
2930
|
* <p> The list of evidence that the <code>GetEvidenceByEvidenceFolder</code> API returned.
|
|
2593
2931
|
* </p>
|
|
2594
2932
|
*/
|
|
2595
2933
|
evidence?: Evidence[];
|
|
2596
2934
|
/**
|
|
2935
|
+
* @public
|
|
2597
2936
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2598
2937
|
*/
|
|
2599
2938
|
nextToken?: string;
|
|
@@ -2603,6 +2942,7 @@ export interface GetEvidenceByEvidenceFolderResponse {
|
|
|
2603
2942
|
*/
|
|
2604
2943
|
export interface GetEvidenceFileUploadUrlRequest {
|
|
2605
2944
|
/**
|
|
2945
|
+
* @public
|
|
2606
2946
|
* <p>The file that you want to upload. For a list of supported file formats, see <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/upload-evidence.html#supported-manual-evidence-files">Supported file types for manual evidence</a> in the <i>Audit Manager
|
|
2607
2947
|
* User Guide</i>.</p>
|
|
2608
2948
|
*/
|
|
@@ -2613,11 +2953,13 @@ export interface GetEvidenceFileUploadUrlRequest {
|
|
|
2613
2953
|
*/
|
|
2614
2954
|
export interface GetEvidenceFileUploadUrlResponse {
|
|
2615
2955
|
/**
|
|
2956
|
+
* @public
|
|
2616
2957
|
* <p>The name of the uploaded manual evidence file that the presigned URL was generated
|
|
2617
2958
|
* for.</p>
|
|
2618
2959
|
*/
|
|
2619
2960
|
evidenceFileName?: string;
|
|
2620
2961
|
/**
|
|
2962
|
+
* @public
|
|
2621
2963
|
* <p>The presigned URL that was generated.</p>
|
|
2622
2964
|
*/
|
|
2623
2965
|
uploadUrl?: string;
|
|
@@ -2627,14 +2969,17 @@ export interface GetEvidenceFileUploadUrlResponse {
|
|
|
2627
2969
|
*/
|
|
2628
2970
|
export interface GetEvidenceFolderRequest {
|
|
2629
2971
|
/**
|
|
2972
|
+
* @public
|
|
2630
2973
|
* <p> The unique identifier for the assessment. </p>
|
|
2631
2974
|
*/
|
|
2632
2975
|
assessmentId: string | undefined;
|
|
2633
2976
|
/**
|
|
2977
|
+
* @public
|
|
2634
2978
|
* <p> The unique identifier for the control set. </p>
|
|
2635
2979
|
*/
|
|
2636
2980
|
controlSetId: string | undefined;
|
|
2637
2981
|
/**
|
|
2982
|
+
* @public
|
|
2638
2983
|
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2639
2984
|
*/
|
|
2640
2985
|
evidenceFolderId: string | undefined;
|
|
@@ -2644,6 +2989,7 @@ export interface GetEvidenceFolderRequest {
|
|
|
2644
2989
|
*/
|
|
2645
2990
|
export interface GetEvidenceFolderResponse {
|
|
2646
2991
|
/**
|
|
2992
|
+
* @public
|
|
2647
2993
|
* <p> The folder that the evidence is stored in. </p>
|
|
2648
2994
|
*/
|
|
2649
2995
|
evidenceFolder?: AssessmentEvidenceFolder;
|
|
@@ -2653,14 +2999,17 @@ export interface GetEvidenceFolderResponse {
|
|
|
2653
2999
|
*/
|
|
2654
3000
|
export interface GetEvidenceFoldersByAssessmentRequest {
|
|
2655
3001
|
/**
|
|
3002
|
+
* @public
|
|
2656
3003
|
* <p> The unique identifier for the assessment. </p>
|
|
2657
3004
|
*/
|
|
2658
3005
|
assessmentId: string | undefined;
|
|
2659
3006
|
/**
|
|
3007
|
+
* @public
|
|
2660
3008
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2661
3009
|
*/
|
|
2662
3010
|
nextToken?: string;
|
|
2663
3011
|
/**
|
|
3012
|
+
* @public
|
|
2664
3013
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
2665
3014
|
*/
|
|
2666
3015
|
maxResults?: number;
|
|
@@ -2670,11 +3019,13 @@ export interface GetEvidenceFoldersByAssessmentRequest {
|
|
|
2670
3019
|
*/
|
|
2671
3020
|
export interface GetEvidenceFoldersByAssessmentResponse {
|
|
2672
3021
|
/**
|
|
3022
|
+
* @public
|
|
2673
3023
|
* <p> The list of evidence folders that the <code>GetEvidenceFoldersByAssessment</code> API
|
|
2674
3024
|
* returned. </p>
|
|
2675
3025
|
*/
|
|
2676
3026
|
evidenceFolders?: AssessmentEvidenceFolder[];
|
|
2677
3027
|
/**
|
|
3028
|
+
* @public
|
|
2678
3029
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2679
3030
|
*/
|
|
2680
3031
|
nextToken?: string;
|
|
@@ -2684,22 +3035,27 @@ export interface GetEvidenceFoldersByAssessmentResponse {
|
|
|
2684
3035
|
*/
|
|
2685
3036
|
export interface GetEvidenceFoldersByAssessmentControlRequest {
|
|
2686
3037
|
/**
|
|
3038
|
+
* @public
|
|
2687
3039
|
* <p> The identifier for the assessment. </p>
|
|
2688
3040
|
*/
|
|
2689
3041
|
assessmentId: string | undefined;
|
|
2690
3042
|
/**
|
|
3043
|
+
* @public
|
|
2691
3044
|
* <p> The identifier for the control set. </p>
|
|
2692
3045
|
*/
|
|
2693
3046
|
controlSetId: string | undefined;
|
|
2694
3047
|
/**
|
|
3048
|
+
* @public
|
|
2695
3049
|
* <p> The identifier for the control. </p>
|
|
2696
3050
|
*/
|
|
2697
3051
|
controlId: string | undefined;
|
|
2698
3052
|
/**
|
|
3053
|
+
* @public
|
|
2699
3054
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2700
3055
|
*/
|
|
2701
3056
|
nextToken?: string;
|
|
2702
3057
|
/**
|
|
3058
|
+
* @public
|
|
2703
3059
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
2704
3060
|
*/
|
|
2705
3061
|
maxResults?: number;
|
|
@@ -2709,11 +3065,13 @@ export interface GetEvidenceFoldersByAssessmentControlRequest {
|
|
|
2709
3065
|
*/
|
|
2710
3066
|
export interface GetEvidenceFoldersByAssessmentControlResponse {
|
|
2711
3067
|
/**
|
|
3068
|
+
* @public
|
|
2712
3069
|
* <p> The list of evidence folders that the
|
|
2713
3070
|
* <code>GetEvidenceFoldersByAssessmentControl</code> API returned. </p>
|
|
2714
3071
|
*/
|
|
2715
3072
|
evidenceFolders?: AssessmentEvidenceFolder[];
|
|
2716
3073
|
/**
|
|
3074
|
+
* @public
|
|
2717
3075
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2718
3076
|
*/
|
|
2719
3077
|
nextToken?: string;
|
|
@@ -2756,10 +3114,12 @@ export interface GetInsightsRequest {
|
|
|
2756
3114
|
*/
|
|
2757
3115
|
export interface Insights {
|
|
2758
3116
|
/**
|
|
3117
|
+
* @public
|
|
2759
3118
|
* <p>The number of active assessments in Audit Manager. </p>
|
|
2760
3119
|
*/
|
|
2761
3120
|
activeAssessmentsCount?: number;
|
|
2762
3121
|
/**
|
|
3122
|
+
* @public
|
|
2763
3123
|
* <p>The number of compliance check evidence that Audit Manager classified as
|
|
2764
3124
|
* non-compliant on the <code>lastUpdated</code> date. This includes evidence that was
|
|
2765
3125
|
* collected from Security Hub with a <i>Fail</i> ruling, or collected
|
|
@@ -2767,6 +3127,7 @@ export interface Insights {
|
|
|
2767
3127
|
*/
|
|
2768
3128
|
noncompliantEvidenceCount?: number;
|
|
2769
3129
|
/**
|
|
3130
|
+
* @public
|
|
2770
3131
|
* <p>The number of compliance check evidence that Audit Manager classified as compliant
|
|
2771
3132
|
* on the <code>lastUpdated</code> date. This includes evidence that was collected from
|
|
2772
3133
|
* Security Hub with a <i>Pass</i> ruling, or collected from
|
|
@@ -2774,6 +3135,7 @@ export interface Insights {
|
|
|
2774
3135
|
*/
|
|
2775
3136
|
compliantEvidenceCount?: number;
|
|
2776
3137
|
/**
|
|
3138
|
+
* @public
|
|
2777
3139
|
* <p>The number of evidence without a compliance check ruling. Evidence is inconclusive when
|
|
2778
3140
|
* the associated control uses Security Hub or Config as a data
|
|
2779
3141
|
* source but you didn't enable those services. This is also the case when a control uses a
|
|
@@ -2786,15 +3148,18 @@ export interface Insights {
|
|
|
2786
3148
|
*/
|
|
2787
3149
|
inconclusiveEvidenceCount?: number;
|
|
2788
3150
|
/**
|
|
3151
|
+
* @public
|
|
2789
3152
|
* <p>The number of assessment controls that collected non-compliant evidence on the
|
|
2790
3153
|
* <code>lastUpdated</code> date. </p>
|
|
2791
3154
|
*/
|
|
2792
3155
|
assessmentControlsCountByNoncompliantEvidence?: number;
|
|
2793
3156
|
/**
|
|
3157
|
+
* @public
|
|
2794
3158
|
* <p>The total number of controls across all active assessments. </p>
|
|
2795
3159
|
*/
|
|
2796
3160
|
totalAssessmentControlsCount?: number;
|
|
2797
3161
|
/**
|
|
3162
|
+
* @public
|
|
2798
3163
|
* <p>The time when the cross-assessment insights were last updated. </p>
|
|
2799
3164
|
*/
|
|
2800
3165
|
lastUpdated?: Date;
|
|
@@ -2804,6 +3169,7 @@ export interface Insights {
|
|
|
2804
3169
|
*/
|
|
2805
3170
|
export interface GetInsightsResponse {
|
|
2806
3171
|
/**
|
|
3172
|
+
* @public
|
|
2807
3173
|
* <p>The analytics data that the <code>GetInsights</code> API returned. </p>
|
|
2808
3174
|
*/
|
|
2809
3175
|
insights?: Insights;
|
|
@@ -2813,6 +3179,7 @@ export interface GetInsightsResponse {
|
|
|
2813
3179
|
*/
|
|
2814
3180
|
export interface GetInsightsByAssessmentRequest {
|
|
2815
3181
|
/**
|
|
3182
|
+
* @public
|
|
2816
3183
|
* <p>The unique identifier for the assessment. </p>
|
|
2817
3184
|
*/
|
|
2818
3185
|
assessmentId: string | undefined;
|
|
@@ -2851,6 +3218,7 @@ export interface GetInsightsByAssessmentRequest {
|
|
|
2851
3218
|
*/
|
|
2852
3219
|
export interface InsightsByAssessment {
|
|
2853
3220
|
/**
|
|
3221
|
+
* @public
|
|
2854
3222
|
* <p>The number of compliance check evidence that Audit Manager classified as
|
|
2855
3223
|
* non-compliant. This includes evidence that was collected from Security Hub with a
|
|
2856
3224
|
* <i>Fail</i> ruling, or collected from Config with a
|
|
@@ -2858,6 +3226,7 @@ export interface InsightsByAssessment {
|
|
|
2858
3226
|
*/
|
|
2859
3227
|
noncompliantEvidenceCount?: number;
|
|
2860
3228
|
/**
|
|
3229
|
+
* @public
|
|
2861
3230
|
* <p>The number of compliance check evidence that Audit Manager classified as compliant.
|
|
2862
3231
|
* This includes evidence that was collected from Security Hub with a
|
|
2863
3232
|
* <i>Pass</i> ruling, or collected from Config with a
|
|
@@ -2865,6 +3234,7 @@ export interface InsightsByAssessment {
|
|
|
2865
3234
|
*/
|
|
2866
3235
|
compliantEvidenceCount?: number;
|
|
2867
3236
|
/**
|
|
3237
|
+
* @public
|
|
2868
3238
|
* <p>The amount of evidence without a compliance check ruling. Evidence is inconclusive if
|
|
2869
3239
|
* the associated control uses Security Hub or Config as a data
|
|
2870
3240
|
* source and you didn't enable those services. This is also the case if a control uses a data
|
|
@@ -2878,15 +3248,18 @@ export interface InsightsByAssessment {
|
|
|
2878
3248
|
*/
|
|
2879
3249
|
inconclusiveEvidenceCount?: number;
|
|
2880
3250
|
/**
|
|
3251
|
+
* @public
|
|
2881
3252
|
* <p>The number of assessment controls that collected non-compliant evidence on the
|
|
2882
3253
|
* <code>lastUpdated</code> date. </p>
|
|
2883
3254
|
*/
|
|
2884
3255
|
assessmentControlsCountByNoncompliantEvidence?: number;
|
|
2885
3256
|
/**
|
|
3257
|
+
* @public
|
|
2886
3258
|
* <p>The total number of controls in the assessment. </p>
|
|
2887
3259
|
*/
|
|
2888
3260
|
totalAssessmentControlsCount?: number;
|
|
2889
3261
|
/**
|
|
3262
|
+
* @public
|
|
2890
3263
|
* <p>The time when the assessment insights were last updated.</p>
|
|
2891
3264
|
*/
|
|
2892
3265
|
lastUpdated?: Date;
|
|
@@ -2896,6 +3269,7 @@ export interface InsightsByAssessment {
|
|
|
2896
3269
|
*/
|
|
2897
3270
|
export interface GetInsightsByAssessmentResponse {
|
|
2898
3271
|
/**
|
|
3272
|
+
* @public
|
|
2899
3273
|
* <p> The assessment analytics data that the <code>GetInsightsByAssessment</code> API
|
|
2900
3274
|
* returned. </p>
|
|
2901
3275
|
*/
|
|
@@ -2911,10 +3285,12 @@ export interface GetOrganizationAdminAccountRequest {
|
|
|
2911
3285
|
*/
|
|
2912
3286
|
export interface GetOrganizationAdminAccountResponse {
|
|
2913
3287
|
/**
|
|
3288
|
+
* @public
|
|
2914
3289
|
* <p> The identifier for the administrator account. </p>
|
|
2915
3290
|
*/
|
|
2916
3291
|
adminAccountId?: string;
|
|
2917
3292
|
/**
|
|
3293
|
+
* @public
|
|
2918
3294
|
* <p> The identifier for the organization. </p>
|
|
2919
3295
|
*/
|
|
2920
3296
|
organizationId?: string;
|
|
@@ -2930,18 +3306,22 @@ export interface GetServicesInScopeRequest {
|
|
|
2930
3306
|
*/
|
|
2931
3307
|
export interface ServiceMetadata {
|
|
2932
3308
|
/**
|
|
3309
|
+
* @public
|
|
2933
3310
|
* <p> The name of the Amazon Web Service. </p>
|
|
2934
3311
|
*/
|
|
2935
3312
|
name?: string;
|
|
2936
3313
|
/**
|
|
3314
|
+
* @public
|
|
2937
3315
|
* <p> The display name of the Amazon Web Service. </p>
|
|
2938
3316
|
*/
|
|
2939
3317
|
displayName?: string;
|
|
2940
3318
|
/**
|
|
3319
|
+
* @public
|
|
2941
3320
|
* <p> The description of the Amazon Web Service. </p>
|
|
2942
3321
|
*/
|
|
2943
3322
|
description?: string;
|
|
2944
3323
|
/**
|
|
3324
|
+
* @public
|
|
2945
3325
|
* <p> The category that the Amazon Web Service belongs to, such as compute, storage,
|
|
2946
3326
|
* or database. </p>
|
|
2947
3327
|
*/
|
|
@@ -2952,6 +3332,7 @@ export interface ServiceMetadata {
|
|
|
2952
3332
|
*/
|
|
2953
3333
|
export interface GetServicesInScopeResponse {
|
|
2954
3334
|
/**
|
|
3335
|
+
* @public
|
|
2955
3336
|
* <p> The metadata that's associated with the Amazon Web Service. </p>
|
|
2956
3337
|
*/
|
|
2957
3338
|
serviceMetadata?: ServiceMetadata[];
|
|
@@ -2979,6 +3360,7 @@ export type SettingAttribute = (typeof SettingAttribute)[keyof typeof SettingAtt
|
|
|
2979
3360
|
*/
|
|
2980
3361
|
export interface GetSettingsRequest {
|
|
2981
3362
|
/**
|
|
3363
|
+
* @public
|
|
2982
3364
|
* <p> The list of setting attribute enum values. </p>
|
|
2983
3365
|
*/
|
|
2984
3366
|
attribute: SettingAttribute | string | undefined;
|
|
@@ -3000,10 +3382,12 @@ export type ExportDestinationType = (typeof ExportDestinationType)[keyof typeof
|
|
|
3000
3382
|
*/
|
|
3001
3383
|
export interface DefaultExportDestination {
|
|
3002
3384
|
/**
|
|
3385
|
+
* @public
|
|
3003
3386
|
* <p>The destination type, such as Amazon S3.</p>
|
|
3004
3387
|
*/
|
|
3005
3388
|
destinationType?: ExportDestinationType | string;
|
|
3006
3389
|
/**
|
|
3390
|
+
* @public
|
|
3007
3391
|
* <p>The destination bucket where Audit Manager stores exported files.</p>
|
|
3008
3392
|
*/
|
|
3009
3393
|
destination?: string;
|
|
@@ -3040,6 +3424,7 @@ export type DeleteResources = (typeof DeleteResources)[keyof typeof DeleteResour
|
|
|
3040
3424
|
*/
|
|
3041
3425
|
export interface DeregistrationPolicy {
|
|
3042
3426
|
/**
|
|
3427
|
+
* @public
|
|
3043
3428
|
* <p>Specifies which Audit Manager data will be deleted when you deregister Audit Manager.</p>
|
|
3044
3429
|
* <ul>
|
|
3045
3430
|
* <li>
|
|
@@ -3092,12 +3477,14 @@ export type EvidenceFinderEnablementStatus = (typeof EvidenceFinderEnablementSta
|
|
|
3092
3477
|
*/
|
|
3093
3478
|
export interface EvidenceFinderEnablement {
|
|
3094
3479
|
/**
|
|
3480
|
+
* @public
|
|
3095
3481
|
* <p>The Amazon Resource Name (ARN) of the CloudTrail Lake event data store that’s
|
|
3096
3482
|
* used by evidence finder. The event data store is the lake of evidence data that evidence
|
|
3097
3483
|
* finder runs queries against.</p>
|
|
3098
3484
|
*/
|
|
3099
3485
|
eventDataStoreArn?: string;
|
|
3100
3486
|
/**
|
|
3487
|
+
* @public
|
|
3101
3488
|
* <p>The current status of the evidence finder feature and the related event data store. </p>
|
|
3102
3489
|
* <ul>
|
|
3103
3490
|
* <li>
|
|
@@ -3129,6 +3516,7 @@ export interface EvidenceFinderEnablement {
|
|
|
3129
3516
|
*/
|
|
3130
3517
|
enablementStatus?: EvidenceFinderEnablementStatus | string;
|
|
3131
3518
|
/**
|
|
3519
|
+
* @public
|
|
3132
3520
|
* <p>The current status of the evidence data backfill process. </p>
|
|
3133
3521
|
* <p>The backfill starts after you enable evidence finder. During this task, Audit Manager populates an event data store with your past two years’ worth of evidence data so that
|
|
3134
3522
|
* your evidence can be queried.</p>
|
|
@@ -3151,6 +3539,7 @@ export interface EvidenceFinderEnablement {
|
|
|
3151
3539
|
*/
|
|
3152
3540
|
backfillStatus?: EvidenceFinderBackfillStatus | string;
|
|
3153
3541
|
/**
|
|
3542
|
+
* @public
|
|
3154
3543
|
* <p>Represents any errors that occurred when enabling or disabling evidence finder. </p>
|
|
3155
3544
|
*/
|
|
3156
3545
|
error?: string;
|
|
@@ -3161,35 +3550,43 @@ export interface EvidenceFinderEnablement {
|
|
|
3161
3550
|
*/
|
|
3162
3551
|
export interface Settings {
|
|
3163
3552
|
/**
|
|
3553
|
+
* @public
|
|
3164
3554
|
* <p> Specifies whether Organizations is enabled. </p>
|
|
3165
3555
|
*/
|
|
3166
3556
|
isAwsOrgEnabled?: boolean;
|
|
3167
3557
|
/**
|
|
3558
|
+
* @public
|
|
3168
3559
|
* <p> The designated Amazon Simple Notification Service (Amazon SNS) topic. </p>
|
|
3169
3560
|
*/
|
|
3170
3561
|
snsTopic?: string;
|
|
3171
3562
|
/**
|
|
3563
|
+
* @public
|
|
3172
3564
|
* <p>The default S3 destination bucket for storing assessment reports.</p>
|
|
3173
3565
|
*/
|
|
3174
3566
|
defaultAssessmentReportsDestination?: AssessmentReportsDestination;
|
|
3175
3567
|
/**
|
|
3568
|
+
* @public
|
|
3176
3569
|
* <p> The designated default audit owners. </p>
|
|
3177
3570
|
*/
|
|
3178
3571
|
defaultProcessOwners?: Role[];
|
|
3179
3572
|
/**
|
|
3573
|
+
* @public
|
|
3180
3574
|
* <p> The KMS key details. </p>
|
|
3181
3575
|
*/
|
|
3182
3576
|
kmsKey?: string;
|
|
3183
3577
|
/**
|
|
3578
|
+
* @public
|
|
3184
3579
|
* <p>The current evidence finder status and event data store details.</p>
|
|
3185
3580
|
*/
|
|
3186
3581
|
evidenceFinderEnablement?: EvidenceFinderEnablement;
|
|
3187
3582
|
/**
|
|
3583
|
+
* @public
|
|
3188
3584
|
* <p>The deregistration policy for your Audit Manager data. You can
|
|
3189
3585
|
* use this attribute to determine how your data is handled when you deregister Audit Manager.</p>
|
|
3190
3586
|
*/
|
|
3191
3587
|
deregistrationPolicy?: DeregistrationPolicy;
|
|
3192
3588
|
/**
|
|
3589
|
+
* @public
|
|
3193
3590
|
* <p>The default S3 destination bucket for storing evidence finder exports.</p>
|
|
3194
3591
|
*/
|
|
3195
3592
|
defaultExportDestination?: DefaultExportDestination;
|
|
@@ -3199,6 +3596,7 @@ export interface Settings {
|
|
|
3199
3596
|
*/
|
|
3200
3597
|
export interface GetSettingsResponse {
|
|
3201
3598
|
/**
|
|
3599
|
+
* @public
|
|
3202
3600
|
* <p> The settings object that holds all supported Audit Manager settings. </p>
|
|
3203
3601
|
*/
|
|
3204
3602
|
settings?: Settings;
|
|
@@ -3208,18 +3606,22 @@ export interface GetSettingsResponse {
|
|
|
3208
3606
|
*/
|
|
3209
3607
|
export interface ListAssessmentControlInsightsByControlDomainRequest {
|
|
3210
3608
|
/**
|
|
3609
|
+
* @public
|
|
3211
3610
|
* <p>The unique identifier for the control domain. </p>
|
|
3212
3611
|
*/
|
|
3213
3612
|
controlDomainId: string | undefined;
|
|
3214
3613
|
/**
|
|
3614
|
+
* @public
|
|
3215
3615
|
* <p>The unique identifier for the active assessment. </p>
|
|
3216
3616
|
*/
|
|
3217
3617
|
assessmentId: string | undefined;
|
|
3218
3618
|
/**
|
|
3619
|
+
* @public
|
|
3219
3620
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3220
3621
|
*/
|
|
3221
3622
|
nextToken?: string;
|
|
3222
3623
|
/**
|
|
3624
|
+
* @public
|
|
3223
3625
|
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3224
3626
|
*/
|
|
3225
3627
|
maxResults?: number;
|
|
@@ -3230,6 +3632,7 @@ export interface ListAssessmentControlInsightsByControlDomainRequest {
|
|
|
3230
3632
|
*/
|
|
3231
3633
|
export interface EvidenceInsights {
|
|
3232
3634
|
/**
|
|
3635
|
+
* @public
|
|
3233
3636
|
* <p>The number of compliance check evidence that Audit Manager classified as
|
|
3234
3637
|
* non-compliant. This includes evidence that was collected from Security Hub with a
|
|
3235
3638
|
* <i>Fail</i> ruling, or collected from Config with a
|
|
@@ -3237,6 +3640,7 @@ export interface EvidenceInsights {
|
|
|
3237
3640
|
*/
|
|
3238
3641
|
noncompliantEvidenceCount?: number;
|
|
3239
3642
|
/**
|
|
3643
|
+
* @public
|
|
3240
3644
|
* <p>The number of compliance check evidence that Audit Manager classified as compliant.
|
|
3241
3645
|
* This includes evidence that was collected from Security Hub with a
|
|
3242
3646
|
* <i>Pass</i> ruling, or collected from Config with a
|
|
@@ -3244,6 +3648,7 @@ export interface EvidenceInsights {
|
|
|
3244
3648
|
*/
|
|
3245
3649
|
compliantEvidenceCount?: number;
|
|
3246
3650
|
/**
|
|
3651
|
+
* @public
|
|
3247
3652
|
* <p>The number of evidence that a compliance check ruling isn't available for. Evidence is
|
|
3248
3653
|
* inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a
|
|
3249
3654
|
* control uses a data source that doesn’t support compliance checks (for example, manual
|
|
@@ -3265,23 +3670,28 @@ export interface EvidenceInsights {
|
|
|
3265
3670
|
*/
|
|
3266
3671
|
export interface ControlInsightsMetadataByAssessmentItem {
|
|
3267
3672
|
/**
|
|
3673
|
+
* @public
|
|
3268
3674
|
* <p>The name of the assessment control. </p>
|
|
3269
3675
|
*/
|
|
3270
3676
|
name?: string;
|
|
3271
3677
|
/**
|
|
3678
|
+
* @public
|
|
3272
3679
|
* <p>The unique identifier for the assessment control. </p>
|
|
3273
3680
|
*/
|
|
3274
3681
|
id?: string;
|
|
3275
3682
|
/**
|
|
3683
|
+
* @public
|
|
3276
3684
|
* <p>A breakdown of the compliance check status for the evidence that’s associated with the
|
|
3277
3685
|
* assessment control. </p>
|
|
3278
3686
|
*/
|
|
3279
3687
|
evidenceInsights?: EvidenceInsights;
|
|
3280
3688
|
/**
|
|
3689
|
+
* @public
|
|
3281
3690
|
* <p>The name of the control set that the assessment control belongs to. </p>
|
|
3282
3691
|
*/
|
|
3283
3692
|
controlSetName?: string;
|
|
3284
3693
|
/**
|
|
3694
|
+
* @public
|
|
3285
3695
|
* <p>The time when the assessment control insights were last updated. </p>
|
|
3286
3696
|
*/
|
|
3287
3697
|
lastUpdated?: Date;
|
|
@@ -3291,11 +3701,13 @@ export interface ControlInsightsMetadataByAssessmentItem {
|
|
|
3291
3701
|
*/
|
|
3292
3702
|
export interface ListAssessmentControlInsightsByControlDomainResponse {
|
|
3293
3703
|
/**
|
|
3704
|
+
* @public
|
|
3294
3705
|
* <p>The assessment control analytics data that the
|
|
3295
3706
|
* <code>ListAssessmentControlInsightsByControlDomain</code> API returned. </p>
|
|
3296
3707
|
*/
|
|
3297
3708
|
controlInsightsByAssessment?: ControlInsightsMetadataByAssessmentItem[];
|
|
3298
3709
|
/**
|
|
3710
|
+
* @public
|
|
3299
3711
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3300
3712
|
*/
|
|
3301
3713
|
nextToken?: string;
|
|
@@ -3305,14 +3717,17 @@ export interface ListAssessmentControlInsightsByControlDomainResponse {
|
|
|
3305
3717
|
*/
|
|
3306
3718
|
export interface ListAssessmentFrameworksRequest {
|
|
3307
3719
|
/**
|
|
3720
|
+
* @public
|
|
3308
3721
|
* <p> The type of framework, such as a standard framework or a custom framework. </p>
|
|
3309
3722
|
*/
|
|
3310
3723
|
frameworkType: FrameworkType | string | undefined;
|
|
3311
3724
|
/**
|
|
3725
|
+
* @public
|
|
3312
3726
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3313
3727
|
*/
|
|
3314
3728
|
nextToken?: string;
|
|
3315
3729
|
/**
|
|
3730
|
+
* @public
|
|
3316
3731
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3317
3732
|
*/
|
|
3318
3733
|
maxResults?: number;
|
|
@@ -3322,11 +3737,13 @@ export interface ListAssessmentFrameworksRequest {
|
|
|
3322
3737
|
*/
|
|
3323
3738
|
export interface ListAssessmentFrameworksResponse {
|
|
3324
3739
|
/**
|
|
3740
|
+
* @public
|
|
3325
3741
|
* <p> A list of metadata that the <code>ListAssessmentFrameworks</code> API returns for each
|
|
3326
3742
|
* framework.</p>
|
|
3327
3743
|
*/
|
|
3328
3744
|
frameworkMetadataList?: AssessmentFrameworkMetadata[];
|
|
3329
3745
|
/**
|
|
3746
|
+
* @public
|
|
3330
3747
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3331
3748
|
*/
|
|
3332
3749
|
nextToken?: string;
|
|
@@ -3336,14 +3753,17 @@ export interface ListAssessmentFrameworksResponse {
|
|
|
3336
3753
|
*/
|
|
3337
3754
|
export interface ListAssessmentFrameworkShareRequestsRequest {
|
|
3338
3755
|
/**
|
|
3756
|
+
* @public
|
|
3339
3757
|
* <p> Specifies whether the share request is a sent request or a received request.</p>
|
|
3340
3758
|
*/
|
|
3341
3759
|
requestType: ShareRequestType | string | undefined;
|
|
3342
3760
|
/**
|
|
3761
|
+
* @public
|
|
3343
3762
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3344
3763
|
*/
|
|
3345
3764
|
nextToken?: string;
|
|
3346
3765
|
/**
|
|
3766
|
+
* @public
|
|
3347
3767
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3348
3768
|
*/
|
|
3349
3769
|
maxResults?: number;
|
|
@@ -3353,11 +3773,13 @@ export interface ListAssessmentFrameworkShareRequestsRequest {
|
|
|
3353
3773
|
*/
|
|
3354
3774
|
export interface ListAssessmentFrameworkShareRequestsResponse {
|
|
3355
3775
|
/**
|
|
3776
|
+
* @public
|
|
3356
3777
|
* <p> The list of share requests that the <code>ListAssessmentFrameworkShareRequests</code>
|
|
3357
3778
|
* API returned. </p>
|
|
3358
3779
|
*/
|
|
3359
3780
|
assessmentFrameworkShareRequests?: AssessmentFrameworkShareRequest[];
|
|
3360
3781
|
/**
|
|
3782
|
+
* @public
|
|
3361
3783
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3362
3784
|
*/
|
|
3363
3785
|
nextToken?: string;
|
|
@@ -3367,10 +3789,12 @@ export interface ListAssessmentFrameworkShareRequestsResponse {
|
|
|
3367
3789
|
*/
|
|
3368
3790
|
export interface ListAssessmentReportsRequest {
|
|
3369
3791
|
/**
|
|
3792
|
+
* @public
|
|
3370
3793
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3371
3794
|
*/
|
|
3372
3795
|
nextToken?: string;
|
|
3373
3796
|
/**
|
|
3797
|
+
* @public
|
|
3374
3798
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3375
3799
|
*/
|
|
3376
3800
|
maxResults?: number;
|
|
@@ -3380,11 +3804,13 @@ export interface ListAssessmentReportsRequest {
|
|
|
3380
3804
|
*/
|
|
3381
3805
|
export interface ListAssessmentReportsResponse {
|
|
3382
3806
|
/**
|
|
3807
|
+
* @public
|
|
3383
3808
|
* <p> The list of assessment reports that the <code>ListAssessmentReports</code> API
|
|
3384
3809
|
* returned. </p>
|
|
3385
3810
|
*/
|
|
3386
3811
|
assessmentReports?: AssessmentReportMetadata[];
|
|
3387
3812
|
/**
|
|
3813
|
+
* @public
|
|
3388
3814
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3389
3815
|
*/
|
|
3390
3816
|
nextToken?: string;
|
|
@@ -3394,14 +3820,17 @@ export interface ListAssessmentReportsResponse {
|
|
|
3394
3820
|
*/
|
|
3395
3821
|
export interface ListAssessmentsRequest {
|
|
3396
3822
|
/**
|
|
3823
|
+
* @public
|
|
3397
3824
|
* <p> The current status of the assessment.</p>
|
|
3398
3825
|
*/
|
|
3399
3826
|
status?: AssessmentStatus | string;
|
|
3400
3827
|
/**
|
|
3828
|
+
* @public
|
|
3401
3829
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3402
3830
|
*/
|
|
3403
3831
|
nextToken?: string;
|
|
3404
3832
|
/**
|
|
3833
|
+
* @public
|
|
3405
3834
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3406
3835
|
*/
|
|
3407
3836
|
maxResults?: number;
|
|
@@ -3411,11 +3840,13 @@ export interface ListAssessmentsRequest {
|
|
|
3411
3840
|
*/
|
|
3412
3841
|
export interface ListAssessmentsResponse {
|
|
3413
3842
|
/**
|
|
3843
|
+
* @public
|
|
3414
3844
|
* <p>The metadata that the <code>ListAssessments</code> API returns for each
|
|
3415
3845
|
* assessment.</p>
|
|
3416
3846
|
*/
|
|
3417
3847
|
assessmentMetadata?: AssessmentMetadataItem[];
|
|
3418
3848
|
/**
|
|
3849
|
+
* @public
|
|
3419
3850
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3420
3851
|
*/
|
|
3421
3852
|
nextToken?: string;
|
|
@@ -3425,10 +3856,12 @@ export interface ListAssessmentsResponse {
|
|
|
3425
3856
|
*/
|
|
3426
3857
|
export interface ListControlDomainInsightsRequest {
|
|
3427
3858
|
/**
|
|
3859
|
+
* @public
|
|
3428
3860
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3429
3861
|
*/
|
|
3430
3862
|
nextToken?: string;
|
|
3431
3863
|
/**
|
|
3864
|
+
* @public
|
|
3432
3865
|
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3433
3866
|
*/
|
|
3434
3867
|
maxResults?: number;
|
|
@@ -3441,28 +3874,34 @@ export interface ListControlDomainInsightsRequest {
|
|
|
3441
3874
|
*/
|
|
3442
3875
|
export interface ControlDomainInsights {
|
|
3443
3876
|
/**
|
|
3877
|
+
* @public
|
|
3444
3878
|
* <p>The name of the control domain. </p>
|
|
3445
3879
|
*/
|
|
3446
3880
|
name?: string;
|
|
3447
3881
|
/**
|
|
3882
|
+
* @public
|
|
3448
3883
|
* <p>The unique identifier for the control domain. </p>
|
|
3449
3884
|
*/
|
|
3450
3885
|
id?: string;
|
|
3451
3886
|
/**
|
|
3887
|
+
* @public
|
|
3452
3888
|
* <p>The number of controls in the control domain that collected non-compliant evidence on
|
|
3453
3889
|
* the <code>lastUpdated</code> date. </p>
|
|
3454
3890
|
*/
|
|
3455
3891
|
controlsCountByNoncompliantEvidence?: number;
|
|
3456
3892
|
/**
|
|
3893
|
+
* @public
|
|
3457
3894
|
* <p>The total number of controls in the control domain. </p>
|
|
3458
3895
|
*/
|
|
3459
3896
|
totalControlsCount?: number;
|
|
3460
3897
|
/**
|
|
3898
|
+
* @public
|
|
3461
3899
|
* <p>A breakdown of the compliance check status for the evidence that’s associated with the
|
|
3462
3900
|
* control domain. </p>
|
|
3463
3901
|
*/
|
|
3464
3902
|
evidenceInsights?: EvidenceInsights;
|
|
3465
3903
|
/**
|
|
3904
|
+
* @public
|
|
3466
3905
|
* <p>The time when the control domain insights were last updated. </p>
|
|
3467
3906
|
*/
|
|
3468
3907
|
lastUpdated?: Date;
|
|
@@ -3472,11 +3911,13 @@ export interface ControlDomainInsights {
|
|
|
3472
3911
|
*/
|
|
3473
3912
|
export interface ListControlDomainInsightsResponse {
|
|
3474
3913
|
/**
|
|
3914
|
+
* @public
|
|
3475
3915
|
* <p>The control domain analytics data that the <code>ListControlDomainInsights</code> API
|
|
3476
3916
|
* returned. </p>
|
|
3477
3917
|
*/
|
|
3478
3918
|
controlDomainInsights?: ControlDomainInsights[];
|
|
3479
3919
|
/**
|
|
3920
|
+
* @public
|
|
3480
3921
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3481
3922
|
*/
|
|
3482
3923
|
nextToken?: string;
|
|
@@ -3486,14 +3927,17 @@ export interface ListControlDomainInsightsResponse {
|
|
|
3486
3927
|
*/
|
|
3487
3928
|
export interface ListControlDomainInsightsByAssessmentRequest {
|
|
3488
3929
|
/**
|
|
3930
|
+
* @public
|
|
3489
3931
|
* <p>The unique identifier for the active assessment. </p>
|
|
3490
3932
|
*/
|
|
3491
3933
|
assessmentId: string | undefined;
|
|
3492
3934
|
/**
|
|
3935
|
+
* @public
|
|
3493
3936
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3494
3937
|
*/
|
|
3495
3938
|
nextToken?: string;
|
|
3496
3939
|
/**
|
|
3940
|
+
* @public
|
|
3497
3941
|
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3498
3942
|
*/
|
|
3499
3943
|
maxResults?: number;
|
|
@@ -3503,11 +3947,13 @@ export interface ListControlDomainInsightsByAssessmentRequest {
|
|
|
3503
3947
|
*/
|
|
3504
3948
|
export interface ListControlDomainInsightsByAssessmentResponse {
|
|
3505
3949
|
/**
|
|
3950
|
+
* @public
|
|
3506
3951
|
* <p>The control domain analytics data that the
|
|
3507
3952
|
* <code>ListControlDomainInsightsByAssessment</code> API returned. </p>
|
|
3508
3953
|
*/
|
|
3509
3954
|
controlDomainInsights?: ControlDomainInsights[];
|
|
3510
3955
|
/**
|
|
3956
|
+
* @public
|
|
3511
3957
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3512
3958
|
*/
|
|
3513
3959
|
nextToken?: string;
|
|
@@ -3517,14 +3963,17 @@ export interface ListControlDomainInsightsByAssessmentResponse {
|
|
|
3517
3963
|
*/
|
|
3518
3964
|
export interface ListControlInsightsByControlDomainRequest {
|
|
3519
3965
|
/**
|
|
3966
|
+
* @public
|
|
3520
3967
|
* <p>The unique identifier for the control domain. </p>
|
|
3521
3968
|
*/
|
|
3522
3969
|
controlDomainId: string | undefined;
|
|
3523
3970
|
/**
|
|
3971
|
+
* @public
|
|
3524
3972
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3525
3973
|
*/
|
|
3526
3974
|
nextToken?: string;
|
|
3527
3975
|
/**
|
|
3976
|
+
* @public
|
|
3528
3977
|
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3529
3978
|
*/
|
|
3530
3979
|
maxResults?: number;
|
|
@@ -3538,19 +3987,23 @@ export interface ListControlInsightsByControlDomainRequest {
|
|
|
3538
3987
|
*/
|
|
3539
3988
|
export interface ControlInsightsMetadataItem {
|
|
3540
3989
|
/**
|
|
3990
|
+
* @public
|
|
3541
3991
|
* <p>The name of the control. </p>
|
|
3542
3992
|
*/
|
|
3543
3993
|
name?: string;
|
|
3544
3994
|
/**
|
|
3995
|
+
* @public
|
|
3545
3996
|
* <p>The unique identifier for the control. </p>
|
|
3546
3997
|
*/
|
|
3547
3998
|
id?: string;
|
|
3548
3999
|
/**
|
|
4000
|
+
* @public
|
|
3549
4001
|
* <p>A breakdown of the compliance check status for the evidence that’s associated with the
|
|
3550
4002
|
* control. </p>
|
|
3551
4003
|
*/
|
|
3552
4004
|
evidenceInsights?: EvidenceInsights;
|
|
3553
4005
|
/**
|
|
4006
|
+
* @public
|
|
3554
4007
|
* <p>The time when the control insights were last updated. </p>
|
|
3555
4008
|
*/
|
|
3556
4009
|
lastUpdated?: Date;
|
|
@@ -3560,11 +4013,13 @@ export interface ControlInsightsMetadataItem {
|
|
|
3560
4013
|
*/
|
|
3561
4014
|
export interface ListControlInsightsByControlDomainResponse {
|
|
3562
4015
|
/**
|
|
4016
|
+
* @public
|
|
3563
4017
|
* <p>The control analytics data that the <code>ListControlInsightsByControlDomain</code> API
|
|
3564
4018
|
* returned. </p>
|
|
3565
4019
|
*/
|
|
3566
4020
|
controlInsightsMetadata?: ControlInsightsMetadataItem[];
|
|
3567
4021
|
/**
|
|
4022
|
+
* @public
|
|
3568
4023
|
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3569
4024
|
*/
|
|
3570
4025
|
nextToken?: string;
|
|
@@ -3574,14 +4029,17 @@ export interface ListControlInsightsByControlDomainResponse {
|
|
|
3574
4029
|
*/
|
|
3575
4030
|
export interface ListControlsRequest {
|
|
3576
4031
|
/**
|
|
4032
|
+
* @public
|
|
3577
4033
|
* <p> The type of control, such as a standard control or a custom control. </p>
|
|
3578
4034
|
*/
|
|
3579
4035
|
controlType: ControlType | string | undefined;
|
|
3580
4036
|
/**
|
|
4037
|
+
* @public
|
|
3581
4038
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3582
4039
|
*/
|
|
3583
4040
|
nextToken?: string;
|
|
3584
4041
|
/**
|
|
4042
|
+
* @public
|
|
3585
4043
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3586
4044
|
*/
|
|
3587
4045
|
maxResults?: number;
|
|
@@ -3592,27 +4050,33 @@ export interface ListControlsRequest {
|
|
|
3592
4050
|
*/
|
|
3593
4051
|
export interface ControlMetadata {
|
|
3594
4052
|
/**
|
|
4053
|
+
* @public
|
|
3595
4054
|
* <p> The Amazon Resource Name (ARN) of the control. </p>
|
|
3596
4055
|
*/
|
|
3597
4056
|
arn?: string;
|
|
3598
4057
|
/**
|
|
4058
|
+
* @public
|
|
3599
4059
|
* <p> The unique identifier for the control. </p>
|
|
3600
4060
|
*/
|
|
3601
4061
|
id?: string;
|
|
3602
4062
|
/**
|
|
4063
|
+
* @public
|
|
3603
4064
|
* <p> The name of the control. </p>
|
|
3604
4065
|
*/
|
|
3605
4066
|
name?: string;
|
|
3606
4067
|
/**
|
|
4068
|
+
* @public
|
|
3607
4069
|
* <p> The data source that determines where Audit Manager collects evidence from for the
|
|
3608
4070
|
* control. </p>
|
|
3609
4071
|
*/
|
|
3610
4072
|
controlSources?: string;
|
|
3611
4073
|
/**
|
|
4074
|
+
* @public
|
|
3612
4075
|
* <p> The time when the control was created. </p>
|
|
3613
4076
|
*/
|
|
3614
4077
|
createdAt?: Date;
|
|
3615
4078
|
/**
|
|
4079
|
+
* @public
|
|
3616
4080
|
* <p> The time when the control was most recently updated. </p>
|
|
3617
4081
|
*/
|
|
3618
4082
|
lastUpdatedAt?: Date;
|
|
@@ -3622,11 +4086,13 @@ export interface ControlMetadata {
|
|
|
3622
4086
|
*/
|
|
3623
4087
|
export interface ListControlsResponse {
|
|
3624
4088
|
/**
|
|
4089
|
+
* @public
|
|
3625
4090
|
* <p> A list of metadata that the <code>ListControls</code> API returns for each
|
|
3626
4091
|
* control.</p>
|
|
3627
4092
|
*/
|
|
3628
4093
|
controlMetadataList?: ControlMetadata[];
|
|
3629
4094
|
/**
|
|
4095
|
+
* @public
|
|
3630
4096
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3631
4097
|
*/
|
|
3632
4098
|
nextToken?: string;
|
|
@@ -3636,14 +4102,17 @@ export interface ListControlsResponse {
|
|
|
3636
4102
|
*/
|
|
3637
4103
|
export interface ListKeywordsForDataSourceRequest {
|
|
3638
4104
|
/**
|
|
4105
|
+
* @public
|
|
3639
4106
|
* <p> The control mapping data source that the keywords apply to. </p>
|
|
3640
4107
|
*/
|
|
3641
4108
|
source: SourceType | string | undefined;
|
|
3642
4109
|
/**
|
|
4110
|
+
* @public
|
|
3643
4111
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3644
4112
|
*/
|
|
3645
4113
|
nextToken?: string;
|
|
3646
4114
|
/**
|
|
4115
|
+
* @public
|
|
3647
4116
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3648
4117
|
*/
|
|
3649
4118
|
maxResults?: number;
|
|
@@ -3653,10 +4122,12 @@ export interface ListKeywordsForDataSourceRequest {
|
|
|
3653
4122
|
*/
|
|
3654
4123
|
export interface ListKeywordsForDataSourceResponse {
|
|
3655
4124
|
/**
|
|
4125
|
+
* @public
|
|
3656
4126
|
* <p> The list of keywords for the event mapping source. </p>
|
|
3657
4127
|
*/
|
|
3658
4128
|
keywords?: string[];
|
|
3659
4129
|
/**
|
|
4130
|
+
* @public
|
|
3660
4131
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3661
4132
|
*/
|
|
3662
4133
|
nextToken?: string;
|
|
@@ -3666,10 +4137,12 @@ export interface ListKeywordsForDataSourceResponse {
|
|
|
3666
4137
|
*/
|
|
3667
4138
|
export interface ListNotificationsRequest {
|
|
3668
4139
|
/**
|
|
4140
|
+
* @public
|
|
3669
4141
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3670
4142
|
*/
|
|
3671
4143
|
nextToken?: string;
|
|
3672
4144
|
/**
|
|
4145
|
+
* @public
|
|
3673
4146
|
* <p> Represents the maximum number of results on a page or for an API request call. </p>
|
|
3674
4147
|
*/
|
|
3675
4148
|
maxResults?: number;
|
|
@@ -3682,34 +4155,42 @@ export interface ListNotificationsRequest {
|
|
|
3682
4155
|
*/
|
|
3683
4156
|
export interface Notification {
|
|
3684
4157
|
/**
|
|
4158
|
+
* @public
|
|
3685
4159
|
* <p> The unique identifier for the notification. </p>
|
|
3686
4160
|
*/
|
|
3687
4161
|
id?: string;
|
|
3688
4162
|
/**
|
|
4163
|
+
* @public
|
|
3689
4164
|
* <p> The identifier for the assessment. </p>
|
|
3690
4165
|
*/
|
|
3691
4166
|
assessmentId?: string;
|
|
3692
4167
|
/**
|
|
4168
|
+
* @public
|
|
3693
4169
|
* <p> The name of the related assessment. </p>
|
|
3694
4170
|
*/
|
|
3695
4171
|
assessmentName?: string;
|
|
3696
4172
|
/**
|
|
4173
|
+
* @public
|
|
3697
4174
|
* <p> The identifier for the control set. </p>
|
|
3698
4175
|
*/
|
|
3699
4176
|
controlSetId?: string;
|
|
3700
4177
|
/**
|
|
4178
|
+
* @public
|
|
3701
4179
|
* <p> Specifies the name of the control set that the notification is about. </p>
|
|
3702
4180
|
*/
|
|
3703
4181
|
controlSetName?: string;
|
|
3704
4182
|
/**
|
|
4183
|
+
* @public
|
|
3705
4184
|
* <p> The description of the notification. </p>
|
|
3706
4185
|
*/
|
|
3707
4186
|
description?: string;
|
|
3708
4187
|
/**
|
|
4188
|
+
* @public
|
|
3709
4189
|
* <p> The time when the notification was sent. </p>
|
|
3710
4190
|
*/
|
|
3711
4191
|
eventTime?: Date;
|
|
3712
4192
|
/**
|
|
4193
|
+
* @public
|
|
3713
4194
|
* <p> The sender of the notification. </p>
|
|
3714
4195
|
*/
|
|
3715
4196
|
source?: string;
|
|
@@ -3719,10 +4200,12 @@ export interface Notification {
|
|
|
3719
4200
|
*/
|
|
3720
4201
|
export interface ListNotificationsResponse {
|
|
3721
4202
|
/**
|
|
4203
|
+
* @public
|
|
3722
4204
|
* <p> The returned list of notifications. </p>
|
|
3723
4205
|
*/
|
|
3724
4206
|
notifications?: Notification[];
|
|
3725
4207
|
/**
|
|
4208
|
+
* @public
|
|
3726
4209
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
3727
4210
|
*/
|
|
3728
4211
|
nextToken?: string;
|
|
@@ -3732,6 +4215,7 @@ export interface ListNotificationsResponse {
|
|
|
3732
4215
|
*/
|
|
3733
4216
|
export interface ListTagsForResourceRequest {
|
|
3734
4217
|
/**
|
|
4218
|
+
* @public
|
|
3735
4219
|
* <p> The Amazon Resource Name (ARN) of the resource. </p>
|
|
3736
4220
|
*/
|
|
3737
4221
|
resourceArn: string | undefined;
|
|
@@ -3741,6 +4225,7 @@ export interface ListTagsForResourceRequest {
|
|
|
3741
4225
|
*/
|
|
3742
4226
|
export interface ListTagsForResourceResponse {
|
|
3743
4227
|
/**
|
|
4228
|
+
* @public
|
|
3744
4229
|
* <p> The list of tags that the <code>ListTagsForResource</code> API returned. </p>
|
|
3745
4230
|
*/
|
|
3746
4231
|
tags?: Record<string, string>;
|
|
@@ -3750,10 +4235,12 @@ export interface ListTagsForResourceResponse {
|
|
|
3750
4235
|
*/
|
|
3751
4236
|
export interface RegisterAccountRequest {
|
|
3752
4237
|
/**
|
|
4238
|
+
* @public
|
|
3753
4239
|
* <p> The KMS key details. </p>
|
|
3754
4240
|
*/
|
|
3755
4241
|
kmsKey?: string;
|
|
3756
4242
|
/**
|
|
4243
|
+
* @public
|
|
3757
4244
|
* <p> The delegated administrator account for Audit Manager. </p>
|
|
3758
4245
|
*/
|
|
3759
4246
|
delegatedAdminAccount?: string;
|
|
@@ -3763,6 +4250,7 @@ export interface RegisterAccountRequest {
|
|
|
3763
4250
|
*/
|
|
3764
4251
|
export interface RegisterAccountResponse {
|
|
3765
4252
|
/**
|
|
4253
|
+
* @public
|
|
3766
4254
|
* <p> The status of the account registration request. </p>
|
|
3767
4255
|
*/
|
|
3768
4256
|
status?: AccountStatus | string;
|
|
@@ -3772,6 +4260,7 @@ export interface RegisterAccountResponse {
|
|
|
3772
4260
|
*/
|
|
3773
4261
|
export interface RegisterOrganizationAdminAccountRequest {
|
|
3774
4262
|
/**
|
|
4263
|
+
* @public
|
|
3775
4264
|
* <p> The identifier for the delegated administrator account. </p>
|
|
3776
4265
|
*/
|
|
3777
4266
|
adminAccountId: string | undefined;
|
|
@@ -3781,10 +4270,12 @@ export interface RegisterOrganizationAdminAccountRequest {
|
|
|
3781
4270
|
*/
|
|
3782
4271
|
export interface RegisterOrganizationAdminAccountResponse {
|
|
3783
4272
|
/**
|
|
4273
|
+
* @public
|
|
3784
4274
|
* <p> The identifier for the delegated administrator account. </p>
|
|
3785
4275
|
*/
|
|
3786
4276
|
adminAccountId?: string;
|
|
3787
4277
|
/**
|
|
4278
|
+
* @public
|
|
3788
4279
|
* <p> The identifier for the organization. </p>
|
|
3789
4280
|
*/
|
|
3790
4281
|
organizationId?: string;
|
|
@@ -3794,18 +4285,22 @@ export interface RegisterOrganizationAdminAccountResponse {
|
|
|
3794
4285
|
*/
|
|
3795
4286
|
export interface StartAssessmentFrameworkShareRequest {
|
|
3796
4287
|
/**
|
|
4288
|
+
* @public
|
|
3797
4289
|
* <p> The unique identifier for the custom framework to be shared. </p>
|
|
3798
4290
|
*/
|
|
3799
4291
|
frameworkId: string | undefined;
|
|
3800
4292
|
/**
|
|
4293
|
+
* @public
|
|
3801
4294
|
* <p> The Amazon Web Services account of the recipient. </p>
|
|
3802
4295
|
*/
|
|
3803
4296
|
destinationAccount: string | undefined;
|
|
3804
4297
|
/**
|
|
4298
|
+
* @public
|
|
3805
4299
|
* <p> The Amazon Web Services Region of the recipient. </p>
|
|
3806
4300
|
*/
|
|
3807
4301
|
destinationRegion: string | undefined;
|
|
3808
4302
|
/**
|
|
4303
|
+
* @public
|
|
3809
4304
|
* <p> An optional comment from the sender about the share request. </p>
|
|
3810
4305
|
*/
|
|
3811
4306
|
comment?: string;
|
|
@@ -3815,6 +4310,7 @@ export interface StartAssessmentFrameworkShareRequest {
|
|
|
3815
4310
|
*/
|
|
3816
4311
|
export interface StartAssessmentFrameworkShareResponse {
|
|
3817
4312
|
/**
|
|
4313
|
+
* @public
|
|
3818
4314
|
* <p> The share request that's created by the <code>StartAssessmentFrameworkShare</code> API.
|
|
3819
4315
|
* </p>
|
|
3820
4316
|
*/
|
|
@@ -3825,10 +4321,12 @@ export interface StartAssessmentFrameworkShareResponse {
|
|
|
3825
4321
|
*/
|
|
3826
4322
|
export interface TagResourceRequest {
|
|
3827
4323
|
/**
|
|
4324
|
+
* @public
|
|
3828
4325
|
* <p> The Amazon Resource Name (ARN) of the resource. </p>
|
|
3829
4326
|
*/
|
|
3830
4327
|
resourceArn: string | undefined;
|
|
3831
4328
|
/**
|
|
4329
|
+
* @public
|
|
3832
4330
|
* <p> The tags that are associated with the resource. </p>
|
|
3833
4331
|
*/
|
|
3834
4332
|
tags: Record<string, string> | undefined;
|
|
@@ -3843,10 +4341,12 @@ export interface TagResourceResponse {
|
|
|
3843
4341
|
*/
|
|
3844
4342
|
export interface UntagResourceRequest {
|
|
3845
4343
|
/**
|
|
4344
|
+
* @public
|
|
3846
4345
|
* <p> The Amazon Resource Name (ARN) of the specified resource. </p>
|
|
3847
4346
|
*/
|
|
3848
4347
|
resourceArn: string | undefined;
|
|
3849
4348
|
/**
|
|
4349
|
+
* @public
|
|
3850
4350
|
* <p> The name or key of the tag. </p>
|
|
3851
4351
|
*/
|
|
3852
4352
|
tagKeys: string[] | undefined;
|
|
@@ -3861,27 +4361,33 @@ export interface UntagResourceResponse {
|
|
|
3861
4361
|
*/
|
|
3862
4362
|
export interface UpdateAssessmentRequest {
|
|
3863
4363
|
/**
|
|
4364
|
+
* @public
|
|
3864
4365
|
* <p> The unique identifier for the assessment. </p>
|
|
3865
4366
|
*/
|
|
3866
4367
|
assessmentId: string | undefined;
|
|
3867
4368
|
/**
|
|
4369
|
+
* @public
|
|
3868
4370
|
* <p> The name of the assessment to be updated. </p>
|
|
3869
4371
|
*/
|
|
3870
4372
|
assessmentName?: string;
|
|
3871
4373
|
/**
|
|
4374
|
+
* @public
|
|
3872
4375
|
* <p> The description of the assessment. </p>
|
|
3873
4376
|
*/
|
|
3874
4377
|
assessmentDescription?: string;
|
|
3875
4378
|
/**
|
|
4379
|
+
* @public
|
|
3876
4380
|
* <p> The scope of the assessment. </p>
|
|
3877
4381
|
*/
|
|
3878
4382
|
scope: Scope | undefined;
|
|
3879
4383
|
/**
|
|
4384
|
+
* @public
|
|
3880
4385
|
* <p> The assessment report storage destination for the assessment that's being updated.
|
|
3881
4386
|
* </p>
|
|
3882
4387
|
*/
|
|
3883
4388
|
assessmentReportsDestination?: AssessmentReportsDestination;
|
|
3884
4389
|
/**
|
|
4390
|
+
* @public
|
|
3885
4391
|
* <p> The list of roles for the assessment. </p>
|
|
3886
4392
|
*/
|
|
3887
4393
|
roles?: Role[];
|
|
@@ -3891,6 +4397,7 @@ export interface UpdateAssessmentRequest {
|
|
|
3891
4397
|
*/
|
|
3892
4398
|
export interface UpdateAssessmentResponse {
|
|
3893
4399
|
/**
|
|
4400
|
+
* @public
|
|
3894
4401
|
* <p> The response object for the <code>UpdateAssessment</code> API. This is the name of the
|
|
3895
4402
|
* updated assessment.</p>
|
|
3896
4403
|
*/
|
|
@@ -3901,22 +4408,27 @@ export interface UpdateAssessmentResponse {
|
|
|
3901
4408
|
*/
|
|
3902
4409
|
export interface UpdateAssessmentControlRequest {
|
|
3903
4410
|
/**
|
|
4411
|
+
* @public
|
|
3904
4412
|
* <p> The unique identifier for the assessment. </p>
|
|
3905
4413
|
*/
|
|
3906
4414
|
assessmentId: string | undefined;
|
|
3907
4415
|
/**
|
|
4416
|
+
* @public
|
|
3908
4417
|
* <p> The unique identifier for the control set. </p>
|
|
3909
4418
|
*/
|
|
3910
4419
|
controlSetId: string | undefined;
|
|
3911
4420
|
/**
|
|
4421
|
+
* @public
|
|
3912
4422
|
* <p> The unique identifier for the control. </p>
|
|
3913
4423
|
*/
|
|
3914
4424
|
controlId: string | undefined;
|
|
3915
4425
|
/**
|
|
4426
|
+
* @public
|
|
3916
4427
|
* <p> The status of the control. </p>
|
|
3917
4428
|
*/
|
|
3918
4429
|
controlStatus?: ControlStatus | string;
|
|
3919
4430
|
/**
|
|
4431
|
+
* @public
|
|
3920
4432
|
* <p> The comment body text for the control. </p>
|
|
3921
4433
|
*/
|
|
3922
4434
|
commentBody?: string;
|
|
@@ -3926,6 +4438,7 @@ export interface UpdateAssessmentControlRequest {
|
|
|
3926
4438
|
*/
|
|
3927
4439
|
export interface UpdateAssessmentControlResponse {
|
|
3928
4440
|
/**
|
|
4441
|
+
* @public
|
|
3929
4442
|
* <p> The name of the updated control set that the <code>UpdateAssessmentControl</code> API
|
|
3930
4443
|
* returned. </p>
|
|
3931
4444
|
*/
|
|
@@ -3936,18 +4449,22 @@ export interface UpdateAssessmentControlResponse {
|
|
|
3936
4449
|
*/
|
|
3937
4450
|
export interface UpdateAssessmentControlSetStatusRequest {
|
|
3938
4451
|
/**
|
|
4452
|
+
* @public
|
|
3939
4453
|
* <p> The unique identifier for the assessment. </p>
|
|
3940
4454
|
*/
|
|
3941
4455
|
assessmentId: string | undefined;
|
|
3942
4456
|
/**
|
|
4457
|
+
* @public
|
|
3943
4458
|
* <p> The unique identifier for the control set. </p>
|
|
3944
4459
|
*/
|
|
3945
4460
|
controlSetId: string | undefined;
|
|
3946
4461
|
/**
|
|
4462
|
+
* @public
|
|
3947
4463
|
* <p> The status of the control set that's being updated. </p>
|
|
3948
4464
|
*/
|
|
3949
4465
|
status: ControlSetStatus | string | undefined;
|
|
3950
4466
|
/**
|
|
4467
|
+
* @public
|
|
3951
4468
|
* <p> The comment that's related to the status update. </p>
|
|
3952
4469
|
*/
|
|
3953
4470
|
comment: string | undefined;
|
|
@@ -3957,6 +4474,7 @@ export interface UpdateAssessmentControlSetStatusRequest {
|
|
|
3957
4474
|
*/
|
|
3958
4475
|
export interface UpdateAssessmentControlSetStatusResponse {
|
|
3959
4476
|
/**
|
|
4477
|
+
* @public
|
|
3960
4478
|
* <p> The name of the updated control set that the
|
|
3961
4479
|
* <code>UpdateAssessmentControlSetStatus</code> API returned. </p>
|
|
3962
4480
|
*/
|
|
@@ -3968,14 +4486,17 @@ export interface UpdateAssessmentControlSetStatusResponse {
|
|
|
3968
4486
|
*/
|
|
3969
4487
|
export interface UpdateAssessmentFrameworkControlSet {
|
|
3970
4488
|
/**
|
|
4489
|
+
* @public
|
|
3971
4490
|
* <p> The unique identifier for the control set. </p>
|
|
3972
4491
|
*/
|
|
3973
4492
|
id?: string;
|
|
3974
4493
|
/**
|
|
4494
|
+
* @public
|
|
3975
4495
|
* <p> The name of the control set. </p>
|
|
3976
4496
|
*/
|
|
3977
4497
|
name: string | undefined;
|
|
3978
4498
|
/**
|
|
4499
|
+
* @public
|
|
3979
4500
|
* <p> The list of controls that are contained within the control set. </p>
|
|
3980
4501
|
*/
|
|
3981
4502
|
controls: CreateAssessmentFrameworkControl[] | undefined;
|
|
@@ -3985,23 +4506,28 @@ export interface UpdateAssessmentFrameworkControlSet {
|
|
|
3985
4506
|
*/
|
|
3986
4507
|
export interface UpdateAssessmentFrameworkRequest {
|
|
3987
4508
|
/**
|
|
4509
|
+
* @public
|
|
3988
4510
|
* <p> The unique identifier for the framework. </p>
|
|
3989
4511
|
*/
|
|
3990
4512
|
frameworkId: string | undefined;
|
|
3991
4513
|
/**
|
|
4514
|
+
* @public
|
|
3992
4515
|
* <p> The name of the framework to be updated. </p>
|
|
3993
4516
|
*/
|
|
3994
4517
|
name: string | undefined;
|
|
3995
4518
|
/**
|
|
4519
|
+
* @public
|
|
3996
4520
|
* <p> The description of the updated framework. </p>
|
|
3997
4521
|
*/
|
|
3998
4522
|
description?: string;
|
|
3999
4523
|
/**
|
|
4524
|
+
* @public
|
|
4000
4525
|
* <p> The compliance type that the new custom framework supports, such as CIS or HIPAA.
|
|
4001
4526
|
* </p>
|
|
4002
4527
|
*/
|
|
4003
4528
|
complianceType?: string;
|
|
4004
4529
|
/**
|
|
4530
|
+
* @public
|
|
4005
4531
|
* <p> The control sets that are associated with the framework. </p>
|
|
4006
4532
|
*/
|
|
4007
4533
|
controlSets: UpdateAssessmentFrameworkControlSet[] | undefined;
|
|
@@ -4011,6 +4537,7 @@ export interface UpdateAssessmentFrameworkRequest {
|
|
|
4011
4537
|
*/
|
|
4012
4538
|
export interface UpdateAssessmentFrameworkResponse {
|
|
4013
4539
|
/**
|
|
4540
|
+
* @public
|
|
4014
4541
|
* <p> The name of the framework. </p>
|
|
4015
4542
|
*/
|
|
4016
4543
|
framework?: Framework;
|
|
@@ -4033,14 +4560,17 @@ export type ShareRequestAction = (typeof ShareRequestAction)[keyof typeof ShareR
|
|
|
4033
4560
|
*/
|
|
4034
4561
|
export interface UpdateAssessmentFrameworkShareRequest {
|
|
4035
4562
|
/**
|
|
4563
|
+
* @public
|
|
4036
4564
|
* <p> The unique identifier for the share request. </p>
|
|
4037
4565
|
*/
|
|
4038
4566
|
requestId: string | undefined;
|
|
4039
4567
|
/**
|
|
4568
|
+
* @public
|
|
4040
4569
|
* <p>Specifies whether the share request is a sent request or a received request.</p>
|
|
4041
4570
|
*/
|
|
4042
4571
|
requestType: ShareRequestType | string | undefined;
|
|
4043
4572
|
/**
|
|
4573
|
+
* @public
|
|
4044
4574
|
* <p>Specifies the update action for the share request.</p>
|
|
4045
4575
|
*/
|
|
4046
4576
|
action: ShareRequestAction | string | undefined;
|
|
@@ -4050,6 +4580,7 @@ export interface UpdateAssessmentFrameworkShareRequest {
|
|
|
4050
4580
|
*/
|
|
4051
4581
|
export interface UpdateAssessmentFrameworkShareResponse {
|
|
4052
4582
|
/**
|
|
4583
|
+
* @public
|
|
4053
4584
|
* <p> The updated share request that's returned by the
|
|
4054
4585
|
* <code>UpdateAssessmentFrameworkShare</code> operation. </p>
|
|
4055
4586
|
*/
|
|
@@ -4060,10 +4591,12 @@ export interface UpdateAssessmentFrameworkShareResponse {
|
|
|
4060
4591
|
*/
|
|
4061
4592
|
export interface UpdateAssessmentStatusRequest {
|
|
4062
4593
|
/**
|
|
4594
|
+
* @public
|
|
4063
4595
|
* <p> The unique identifier for the assessment. </p>
|
|
4064
4596
|
*/
|
|
4065
4597
|
assessmentId: string | undefined;
|
|
4066
4598
|
/**
|
|
4599
|
+
* @public
|
|
4067
4600
|
* <p> The current status of the assessment. </p>
|
|
4068
4601
|
*/
|
|
4069
4602
|
status: AssessmentStatus | string | undefined;
|
|
@@ -4073,6 +4606,7 @@ export interface UpdateAssessmentStatusRequest {
|
|
|
4073
4606
|
*/
|
|
4074
4607
|
export interface UpdateAssessmentStatusResponse {
|
|
4075
4608
|
/**
|
|
4609
|
+
* @public
|
|
4076
4610
|
* <p> The name of the updated assessment that the <code>UpdateAssessmentStatus</code> API
|
|
4077
4611
|
* returned. </p>
|
|
4078
4612
|
*/
|
|
@@ -4083,30 +4617,37 @@ export interface UpdateAssessmentStatusResponse {
|
|
|
4083
4617
|
*/
|
|
4084
4618
|
export interface UpdateControlRequest {
|
|
4085
4619
|
/**
|
|
4620
|
+
* @public
|
|
4086
4621
|
* <p> The identifier for the control. </p>
|
|
4087
4622
|
*/
|
|
4088
4623
|
controlId: string | undefined;
|
|
4089
4624
|
/**
|
|
4625
|
+
* @public
|
|
4090
4626
|
* <p> The name of the updated control. </p>
|
|
4091
4627
|
*/
|
|
4092
4628
|
name: string | undefined;
|
|
4093
4629
|
/**
|
|
4630
|
+
* @public
|
|
4094
4631
|
* <p> The optional description of the control. </p>
|
|
4095
4632
|
*/
|
|
4096
4633
|
description?: string;
|
|
4097
4634
|
/**
|
|
4635
|
+
* @public
|
|
4098
4636
|
* <p> The steps that you should follow to determine if the control is met. </p>
|
|
4099
4637
|
*/
|
|
4100
4638
|
testingInformation?: string;
|
|
4101
4639
|
/**
|
|
4640
|
+
* @public
|
|
4102
4641
|
* <p> The title of the action plan for remediating the control. </p>
|
|
4103
4642
|
*/
|
|
4104
4643
|
actionPlanTitle?: string;
|
|
4105
4644
|
/**
|
|
4645
|
+
* @public
|
|
4106
4646
|
* <p> The recommended actions to carry out if the control isn't fulfilled. </p>
|
|
4107
4647
|
*/
|
|
4108
4648
|
actionPlanInstructions?: string;
|
|
4109
4649
|
/**
|
|
4650
|
+
* @public
|
|
4110
4651
|
* <p> The data mapping sources for the control. </p>
|
|
4111
4652
|
*/
|
|
4112
4653
|
controlMappingSources: ControlMappingSource[] | undefined;
|
|
@@ -4116,6 +4657,7 @@ export interface UpdateControlRequest {
|
|
|
4116
4657
|
*/
|
|
4117
4658
|
export interface UpdateControlResponse {
|
|
4118
4659
|
/**
|
|
4660
|
+
* @public
|
|
4119
4661
|
* <p> The name of the updated control set that the <code>UpdateControl</code> API returned.
|
|
4120
4662
|
* </p>
|
|
4121
4663
|
*/
|
|
@@ -4126,23 +4668,28 @@ export interface UpdateControlResponse {
|
|
|
4126
4668
|
*/
|
|
4127
4669
|
export interface UpdateSettingsRequest {
|
|
4128
4670
|
/**
|
|
4671
|
+
* @public
|
|
4129
4672
|
* <p> The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends
|
|
4130
4673
|
* notifications to. </p>
|
|
4131
4674
|
*/
|
|
4132
4675
|
snsTopic?: string;
|
|
4133
4676
|
/**
|
|
4677
|
+
* @public
|
|
4134
4678
|
* <p> The default S3 destination bucket for storing assessment reports. </p>
|
|
4135
4679
|
*/
|
|
4136
4680
|
defaultAssessmentReportsDestination?: AssessmentReportsDestination;
|
|
4137
4681
|
/**
|
|
4682
|
+
* @public
|
|
4138
4683
|
* <p> A list of the default audit owners. </p>
|
|
4139
4684
|
*/
|
|
4140
4685
|
defaultProcessOwners?: Role[];
|
|
4141
4686
|
/**
|
|
4687
|
+
* @public
|
|
4142
4688
|
* <p> The KMS key details. </p>
|
|
4143
4689
|
*/
|
|
4144
4690
|
kmsKey?: string;
|
|
4145
4691
|
/**
|
|
4692
|
+
* @public
|
|
4146
4693
|
* <p>Specifies whether the evidence finder feature is enabled. Change this attribute to
|
|
4147
4694
|
* enable or disable evidence finder.</p>
|
|
4148
4695
|
* <important>
|
|
@@ -4154,11 +4701,13 @@ export interface UpdateSettingsRequest {
|
|
|
4154
4701
|
*/
|
|
4155
4702
|
evidenceFinderEnabled?: boolean;
|
|
4156
4703
|
/**
|
|
4704
|
+
* @public
|
|
4157
4705
|
* <p>The deregistration policy for your Audit Manager data. You can
|
|
4158
4706
|
* use this attribute to determine how your data is handled when you deregister Audit Manager.</p>
|
|
4159
4707
|
*/
|
|
4160
4708
|
deregistrationPolicy?: DeregistrationPolicy;
|
|
4161
4709
|
/**
|
|
4710
|
+
* @public
|
|
4162
4711
|
* <p> The default S3 destination bucket for storing evidence finder exports. </p>
|
|
4163
4712
|
*/
|
|
4164
4713
|
defaultExportDestination?: DefaultExportDestination;
|
|
@@ -4168,6 +4717,7 @@ export interface UpdateSettingsRequest {
|
|
|
4168
4717
|
*/
|
|
4169
4718
|
export interface UpdateSettingsResponse {
|
|
4170
4719
|
/**
|
|
4720
|
+
* @public
|
|
4171
4721
|
* <p> The current list of settings. </p>
|
|
4172
4722
|
*/
|
|
4173
4723
|
settings?: Settings;
|
|
@@ -4177,6 +4727,7 @@ export interface UpdateSettingsResponse {
|
|
|
4177
4727
|
*/
|
|
4178
4728
|
export interface ValidateAssessmentReportIntegrityRequest {
|
|
4179
4729
|
/**
|
|
4730
|
+
* @public
|
|
4180
4731
|
* <p> The relative path of the Amazon S3 bucket that the assessment report is stored
|
|
4181
4732
|
* in. </p>
|
|
4182
4733
|
*/
|
|
@@ -4187,23 +4738,28 @@ export interface ValidateAssessmentReportIntegrityRequest {
|
|
|
4187
4738
|
*/
|
|
4188
4739
|
export interface ValidateAssessmentReportIntegrityResponse {
|
|
4189
4740
|
/**
|
|
4741
|
+
* @public
|
|
4190
4742
|
* <p> Specifies whether the signature key is valid. </p>
|
|
4191
4743
|
*/
|
|
4192
4744
|
signatureValid?: boolean;
|
|
4193
4745
|
/**
|
|
4746
|
+
* @public
|
|
4194
4747
|
* <p> The signature algorithm that's used to code sign the assessment report file. </p>
|
|
4195
4748
|
*/
|
|
4196
4749
|
signatureAlgorithm?: string;
|
|
4197
4750
|
/**
|
|
4751
|
+
* @public
|
|
4198
4752
|
* <p> The date and time signature that specifies when the assessment report was created.
|
|
4199
4753
|
* </p>
|
|
4200
4754
|
*/
|
|
4201
4755
|
signatureDateTime?: string;
|
|
4202
4756
|
/**
|
|
4757
|
+
* @public
|
|
4203
4758
|
* <p> The unique identifier for the validation signature key. </p>
|
|
4204
4759
|
*/
|
|
4205
4760
|
signatureKeyId?: string;
|
|
4206
4761
|
/**
|
|
4762
|
+
* @public
|
|
4207
4763
|
* <p> Represents any errors that occurred when validating the assessment report. </p>
|
|
4208
4764
|
*/
|
|
4209
4765
|
validationErrors?: string[];
|