@aws-sdk/client-auditmanager 3.137.0 → 3.142.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.
@@ -177,16 +177,15 @@ export declare class AuditManager extends AuditManagerClient {
177
177
  deleteAssessmentFramework(args: DeleteAssessmentFrameworkCommandInput, cb: (err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void): void;
178
178
  deleteAssessmentFramework(args: DeleteAssessmentFrameworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentFrameworkCommandOutput) => void): void;
179
179
  /**
180
- * <p>
181
- * Deletes a share request for a custom framework in Audit Manager.
182
- * </p>
180
+ * <p> Deletes a share request for a custom framework in Audit Manager. </p>
183
181
  */
184
182
  deleteAssessmentFrameworkShare(args: DeleteAssessmentFrameworkShareCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssessmentFrameworkShareCommandOutput>;
185
183
  deleteAssessmentFrameworkShare(args: DeleteAssessmentFrameworkShareCommandInput, cb: (err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void): void;
186
184
  deleteAssessmentFrameworkShare(args: DeleteAssessmentFrameworkShareCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssessmentFrameworkShareCommandOutput) => void): void;
187
185
  /**
188
186
  * <p>Deletes an assessment report in Audit Manager. </p>
189
- * <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager attempts to delete the following data:</p>
187
+ * <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager
188
+ * attempts to delete the following data:</p>
190
189
  * <ol>
191
190
  * <li>
192
191
  * <p>The specified assessment report that’s stored in your S3 bucket</p>
@@ -219,8 +218,8 @@ export declare class AuditManager extends AuditManagerClient {
219
218
  /**
220
219
  * <p> Deregisters an account in Audit Manager. </p>
221
220
  * <note>
222
- * <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
223
- * to delete your resource data, you must perform that task separately before you
221
+ * <p>When you deregister your account from Audit Manager, your data isn’t deleted. If
222
+ * you want to delete your resource data, you must perform that task separately before you
224
223
  * deregister your account. Either, you can do this in the Audit Manager console. Or,
225
224
  * you can use one of the delete API operations that are provided by Audit Manager. </p>
226
225
  * <p>To delete your Audit Manager resource data, see the following instructions: </p>
@@ -272,11 +271,11 @@ export declare class AuditManager extends AuditManagerClient {
272
271
  * evidence to that delegated administrator account moving forward.</p>
273
272
  * </important>
274
273
  * <note>
275
- * <p>When you deregister a delegated administrator account for Audit Manager, the data for that
276
- * account isn’t deleted. If you want to delete resource data for a delegated administrator
277
- * account, you must perform that task separately before you deregister the account.
278
- * Either, you can do this in the Audit Manager console. Or, you can use one of the
279
- * delete API operations that are provided by Audit Manager. </p>
274
+ * <p>When you deregister a delegated administrator account for Audit Manager, the data
275
+ * for that account isn’t deleted. If you want to delete resource data for a delegated
276
+ * administrator account, you must perform that task separately before you deregister the
277
+ * account. Either, you can do this in the Audit Manager console. Or, you can use one
278
+ * of the delete API operations that are provided by Audit Manager. </p>
280
279
  * <p>To delete your Audit Manager resource data, see the following instructions: </p>
281
280
  * <ul>
282
281
  * <li>
@@ -432,10 +431,10 @@ export declare class AuditManager extends AuditManagerClient {
432
431
  * <p>Lists the latest analytics data for controls within a specific control domain and a
433
432
  * specific active assessment.</p>
434
433
  * <note>
435
- * <p>Control insights are listed only if the control belongs to the control domain and assessment
436
- * that was specified. Moreover, the control must have collected evidence on the
437
- * <code>lastUpdated</code> date of <code>controlInsightsByAssessment</code>. If neither
438
- * of these conditions are met, no data is listed for that control. </p>
434
+ * <p>Control insights are listed only if the control belongs to the control domain and
435
+ * assessment that was specified. Moreover, the control must have collected evidence on the
436
+ * <code>lastUpdated</code> date of <code>controlInsightsByAssessment</code>. If neither
437
+ * of these conditions are met, no data is listed for that control. </p>
439
438
  * </note>
440
439
  */
441
440
  listAssessmentControlInsightsByControlDomain(args: ListAssessmentControlInsightsByControlDomainCommandInput, options?: __HttpHandlerOptions): Promise<ListAssessmentControlInsightsByControlDomainCommandOutput>;
@@ -470,9 +469,10 @@ export declare class AuditManager extends AuditManagerClient {
470
469
  * <p>Lists the latest analytics data for control domains across all of your active
471
470
  * assessments. </p>
472
471
  * <note>
473
- * <p>A control domain is listed only if at least one of the controls within that domain collected
474
- * evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If
475
- * this condition isn’t met, no data is listed for that control domain.</p>
472
+ * <p>A control domain is listed only if at least one of the controls within that domain
473
+ * collected evidence on the <code>lastUpdated</code> date of
474
+ * <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed
475
+ * for that control domain.</p>
476
476
  * </note>
477
477
  */
478
478
  listControlDomainInsights(args: ListControlDomainInsightsCommandInput, options?: __HttpHandlerOptions): Promise<ListControlDomainInsightsCommandOutput>;
@@ -481,9 +481,10 @@ export declare class AuditManager extends AuditManagerClient {
481
481
  /**
482
482
  * <p>Lists analytics data for control domains within a specified active assessment.</p>
483
483
  * <note>
484
- * <p>A control domain is listed only if at least one of the controls within that domain collected
485
- * evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If
486
- * this condition isn’t met, no data is listed for that domain.</p>
484
+ * <p>A control domain is listed only if at least one of the controls within that domain
485
+ * collected evidence on the <code>lastUpdated</code> date of
486
+ * <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed
487
+ * for that domain.</p>
487
488
  * </note>
488
489
  */
489
490
  listControlDomainInsightsByAssessment(args: ListControlDomainInsightsByAssessmentCommandInput, options?: __HttpHandlerOptions): Promise<ListControlDomainInsightsByAssessmentCommandOutput>;
@@ -493,10 +494,10 @@ export declare class AuditManager extends AuditManagerClient {
493
494
  * <p>Lists the latest analytics data for controls within a specific control domain across all
494
495
  * active assessments.</p>
495
496
  * <note>
496
- * <p>Control insights are listed only if the control belongs to the control domain that was
497
- * specified and the control collected evidence on the <code>lastUpdated</code> date of
498
- * <code>controlInsightsMetadata</code>. If neither of these conditions are met, no data
499
- * is listed for that control. </p>
497
+ * <p>Control insights are listed only if the control belongs to the control domain that
498
+ * was specified and the control collected evidence on the <code>lastUpdated</code> date of
499
+ * <code>controlInsightsMetadata</code>. If neither of these conditions are met, no data
500
+ * is listed for that control. </p>
500
501
  * </note>
501
502
  */
502
503
  listControlInsightsByControlDomain(args: ListControlInsightsByControlDomainCommandInput, options?: __HttpHandlerOptions): Promise<ListControlInsightsByControlDomainCommandOutput>;
@@ -509,7 +510,8 @@ export declare class AuditManager extends AuditManagerClient {
509
510
  listControls(args: ListControlsCommandInput, cb: (err: any, data?: ListControlsCommandOutput) => void): void;
510
511
  listControls(args: ListControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlsCommandOutput) => void): void;
511
512
  /**
512
- * <p> Returns a list of keywords that are pre-mapped to the specified control data source. </p>
513
+ * <p> Returns a list of keywords that are pre-mapped to the specified control data source.
514
+ * </p>
513
515
  */
514
516
  listKeywordsForDataSource(args: ListKeywordsForDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<ListKeywordsForDataSourceCommandOutput>;
515
517
  listKeywordsForDataSource(args: ListKeywordsForDataSourceCommandInput, cb: (err: any, data?: ListKeywordsForDataSourceCommandOutput) => void): void;
@@ -541,7 +543,9 @@ export declare class AuditManager extends AuditManagerClient {
541
543
  registerOrganizationAdminAccount(args: RegisterOrganizationAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterOrganizationAdminAccountCommandOutput) => void): void;
542
544
  /**
543
545
  * <p> Creates a share request for a custom framework in Audit Manager. </p>
544
- * <p>The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.</p>
546
+ * <p>The share request specifies a recipient and notifies them that a custom framework is
547
+ * available. Recipients have 120 days to accept or decline the request. If no action is
548
+ * taken, the share request expires.</p>
545
549
  * <p>When you create a share request, Audit Manager stores a snapshot of your custom
546
550
  * framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also
547
551
  * stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.</p>
@@ -564,8 +568,8 @@ export declare class AuditManager extends AuditManagerClient {
564
568
  * </ul>
565
569
  * <p>When a sender <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend">resends a share request</a>, the snapshot is replaced with an updated version that
566
570
  * corresponds with the latest version of the custom framework. </p>
567
- * <p>When a recipient accepts a share request, the snapshot is replicated into their
568
- * Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. </p>
571
+ * <p>When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share
572
+ * request. </p>
569
573
  * <important>
570
574
  * <p>When you invoke the <code>StartAssessmentFrameworkShare</code> API, you are about to
571
575
  * share a custom framework with another Amazon Web Services account. You may not share a
@@ -7,9 +7,7 @@ export interface DeleteAssessmentFrameworkShareCommandInput extends DeleteAssess
7
7
  export interface DeleteAssessmentFrameworkShareCommandOutput extends DeleteAssessmentFrameworkShareResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>
11
- * Deletes a share request for a custom framework in Audit Manager.
12
- * </p>
10
+ * <p> Deletes a share request for a custom framework in Audit Manager. </p>
13
11
  * @example
14
12
  * Use a bare-bones client and the command you need to make an API call.
15
13
  * ```javascript
@@ -8,7 +8,8 @@ export interface DeleteAssessmentReportCommandOutput extends DeleteAssessmentRep
8
8
  }
9
9
  /**
10
10
  * <p>Deletes an assessment report in Audit Manager. </p>
11
- * <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager attempts to delete the following data:</p>
11
+ * <p>When you run the <code>DeleteAssessmentReport</code> operation, Audit Manager
12
+ * attempts to delete the following data:</p>
12
13
  * <ol>
13
14
  * <li>
14
15
  * <p>The specified assessment report that’s stored in your S3 bucket</p>
@@ -9,8 +9,8 @@ export interface DeregisterAccountCommandOutput extends DeregisterAccountRespons
9
9
  /**
10
10
  * <p> Deregisters an account in Audit Manager. </p>
11
11
  * <note>
12
- * <p>When you deregister your account from Audit Manager, your data isn’t deleted. If you want
13
- * to delete your resource data, you must perform that task separately before you
12
+ * <p>When you deregister your account from Audit Manager, your data isn’t deleted. If
13
+ * you want to delete your resource data, you must perform that task separately before you
14
14
  * deregister your account. Either, you can do this in the Audit Manager console. Or,
15
15
  * you can use one of the delete API operations that are provided by Audit Manager. </p>
16
16
  * <p>To delete your Audit Manager resource data, see the following instructions: </p>
@@ -17,11 +17,11 @@ export interface DeregisterOrganizationAdminAccountCommandOutput extends Deregis
17
17
  * evidence to that delegated administrator account moving forward.</p>
18
18
  * </important>
19
19
  * <note>
20
- * <p>When you deregister a delegated administrator account for Audit Manager, the data for that
21
- * account isn’t deleted. If you want to delete resource data for a delegated administrator
22
- * account, you must perform that task separately before you deregister the account.
23
- * Either, you can do this in the Audit Manager console. Or, you can use one of the
24
- * delete API operations that are provided by Audit Manager. </p>
20
+ * <p>When you deregister a delegated administrator account for Audit Manager, the data
21
+ * for that account isn’t deleted. If you want to delete resource data for a delegated
22
+ * administrator account, you must perform that task separately before you deregister the
23
+ * account. Either, you can do this in the Audit Manager console. Or, you can use one
24
+ * of the delete API operations that are provided by Audit Manager. </p>
25
25
  * <p>To delete your Audit Manager resource data, see the following instructions: </p>
26
26
  * <ul>
27
27
  * <li>
@@ -10,10 +10,10 @@ export interface ListAssessmentControlInsightsByControlDomainCommandOutput exten
10
10
  * <p>Lists the latest analytics data for controls within a specific control domain and a
11
11
  * specific active assessment.</p>
12
12
  * <note>
13
- * <p>Control insights are listed only if the control belongs to the control domain and assessment
14
- * that was specified. Moreover, the control must have collected evidence on the
15
- * <code>lastUpdated</code> date of <code>controlInsightsByAssessment</code>. If neither
16
- * of these conditions are met, no data is listed for that control. </p>
13
+ * <p>Control insights are listed only if the control belongs to the control domain and
14
+ * assessment that was specified. Moreover, the control must have collected evidence on the
15
+ * <code>lastUpdated</code> date of <code>controlInsightsByAssessment</code>. If neither
16
+ * of these conditions are met, no data is listed for that control. </p>
17
17
  * </note>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,9 +9,10 @@ export interface ListControlDomainInsightsByAssessmentCommandOutput extends List
9
9
  /**
10
10
  * <p>Lists analytics data for control domains within a specified active assessment.</p>
11
11
  * <note>
12
- * <p>A control domain is listed only if at least one of the controls within that domain collected
13
- * evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If
14
- * this condition isn’t met, no data is listed for that domain.</p>
12
+ * <p>A control domain is listed only if at least one of the controls within that domain
13
+ * collected evidence on the <code>lastUpdated</code> date of
14
+ * <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed
15
+ * for that domain.</p>
15
16
  * </note>
16
17
  * @example
17
18
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,9 +10,10 @@ export interface ListControlDomainInsightsCommandOutput extends ListControlDomai
10
10
  * <p>Lists the latest analytics data for control domains across all of your active
11
11
  * assessments. </p>
12
12
  * <note>
13
- * <p>A control domain is listed only if at least one of the controls within that domain collected
14
- * evidence on the <code>lastUpdated</code> date of <code>controlDomainInsights</code>. If
15
- * this condition isn’t met, no data is listed for that control domain.</p>
13
+ * <p>A control domain is listed only if at least one of the controls within that domain
14
+ * collected evidence on the <code>lastUpdated</code> date of
15
+ * <code>controlDomainInsights</code>. If this condition isn’t met, no data is listed
16
+ * for that control domain.</p>
16
17
  * </note>
17
18
  * @example
18
19
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,10 +10,10 @@ export interface ListControlInsightsByControlDomainCommandOutput extends ListCon
10
10
  * <p>Lists the latest analytics data for controls within a specific control domain across all
11
11
  * active assessments.</p>
12
12
  * <note>
13
- * <p>Control insights are listed only if the control belongs to the control domain that was
14
- * specified and the control collected evidence on the <code>lastUpdated</code> date of
15
- * <code>controlInsightsMetadata</code>. If neither of these conditions are met, no data
16
- * is listed for that control. </p>
13
+ * <p>Control insights are listed only if the control belongs to the control domain that
14
+ * was specified and the control collected evidence on the <code>lastUpdated</code> date of
15
+ * <code>controlInsightsMetadata</code>. If neither of these conditions are met, no data
16
+ * is listed for that control. </p>
17
17
  * </note>
18
18
  * @example
19
19
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,8 @@ export interface ListKeywordsForDataSourceCommandInput extends ListKeywordsForDa
7
7
  export interface ListKeywordsForDataSourceCommandOutput extends ListKeywordsForDataSourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p> Returns a list of keywords that are pre-mapped to the specified control data source. </p>
10
+ * <p> Returns a list of keywords that are pre-mapped to the specified control data source.
11
+ * </p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -8,7 +8,9 @@ export interface StartAssessmentFrameworkShareCommandOutput extends StartAssessm
8
8
  }
9
9
  /**
10
10
  * <p> Creates a share request for a custom framework in Audit Manager. </p>
11
- * <p>The share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.</p>
11
+ * <p>The share request specifies a recipient and notifies them that a custom framework is
12
+ * available. Recipients have 120 days to accept or decline the request. If no action is
13
+ * taken, the share request expires.</p>
12
14
  * <p>When you create a share request, Audit Manager stores a snapshot of your custom
13
15
  * framework in the US East (N. Virginia) Amazon Web Services Region. Audit Manager also
14
16
  * stores a backup of the same snapshot in the US West (Oregon) Amazon Web Services Region.</p>
@@ -31,8 +33,8 @@ export interface StartAssessmentFrameworkShareCommandOutput extends StartAssessm
31
33
  * </ul>
32
34
  * <p>When a sender <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/framework-sharing.html#framework-sharing-resend">resends a share request</a>, the snapshot is replaced with an updated version that
33
35
  * corresponds with the latest version of the custom framework. </p>
34
- * <p>When a recipient accepts a share request, the snapshot is replicated into their
35
- * Amazon Web Services account under the Amazon Web Services Region that was specified in the share request. </p>
36
+ * <p>When a recipient accepts a share request, the snapshot is replicated into their Amazon Web Services account under the Amazon Web Services Region that was specified in the share
37
+ * request. </p>
36
38
  * <important>
37
39
  * <p>When you invoke the <code>StartAssessmentFrameworkShare</code> API, you are about to
38
40
  * share a custom framework with another Amazon Web Services account. You may not share a