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