@aws-sdk/client-auditmanager 3.41.0 → 3.46.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/CHANGELOG.md +47 -0
- package/dist-cjs/AuditManager.js +90 -0
- package/dist-cjs/commands/GetInsightsByAssessmentCommand.js +36 -0
- package/dist-cjs/commands/GetInsightsCommand.js +36 -0
- package/dist-cjs/commands/ListAssessmentControlInsightsByControlDomainCommand.js +36 -0
- package/dist-cjs/commands/ListControlDomainInsightsByAssessmentCommand.js +36 -0
- package/dist-cjs/commands/ListControlDomainInsightsCommand.js +36 -0
- package/dist-cjs/commands/ListControlInsightsByControlDomainCommand.js +36 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +110 -2
- package/dist-cjs/pagination/ListAssessmentControlInsightsByControlDomainPaginator.js +35 -0
- package/dist-cjs/pagination/ListControlDomainInsightsByAssessmentPaginator.js +35 -0
- package/dist-cjs/pagination/ListControlDomainInsightsPaginator.js +35 -0
- package/dist-cjs/pagination/ListControlInsightsByControlDomainPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +753 -86
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/AuditManager.js +90 -0
- package/dist-es/commands/GetInsightsByAssessmentCommand.js +39 -0
- package/dist-es/commands/GetInsightsCommand.js +39 -0
- package/dist-es/commands/ListAssessmentControlInsightsByControlDomainCommand.js +39 -0
- package/dist-es/commands/ListControlDomainInsightsByAssessmentCommand.js +39 -0
- package/dist-es/commands/ListControlDomainInsightsCommand.js +39 -0
- package/dist-es/commands/ListControlInsightsByControlDomainCommand.js +39 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +72 -0
- package/dist-es/pagination/ListAssessmentControlInsightsByControlDomainPaginator.js +74 -0
- package/dist-es/pagination/ListControlDomainInsightsByAssessmentPaginator.js +74 -0
- package/dist-es/pagination/ListControlDomainInsightsPaginator.js +74 -0
- package/dist-es/pagination/ListControlInsightsByControlDomainPaginator.js +74 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +798 -34
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/AuditManager.d.ts +69 -2
- package/dist-types/AuditManagerClient.d.ts +8 -2
- package/dist-types/commands/GetAssessmentCommand.d.ts +1 -1
- package/dist-types/commands/GetAssessmentFrameworkCommand.d.ts +1 -1
- package/dist-types/commands/GetInsightsByAssessmentCommand.d.ts +35 -0
- package/dist-types/commands/GetInsightsCommand.d.ts +35 -0
- package/dist-types/commands/ListAssessmentControlInsightsByControlDomainCommand.d.ts +42 -0
- package/dist-types/commands/ListControlDomainInsightsByAssessmentCommand.d.ts +40 -0
- package/dist-types/commands/ListControlDomainInsightsCommand.d.ts +41 -0
- package/dist-types/commands/ListControlInsightsByControlDomainCommand.d.ts +42 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +521 -30
- package/dist-types/pagination/ListAssessmentControlInsightsByControlDomainPaginator.d.ts +4 -0
- package/dist-types/pagination/ListControlDomainInsightsByAssessmentPaginator.d.ts +4 -0
- package/dist-types/pagination/ListControlDomainInsightsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListControlInsightsByControlDomainPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/AuditManager.d.ts +30 -0
- package/dist-types/ts3.4/AuditManagerClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/GetInsightsByAssessmentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/GetInsightsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAssessmentControlInsightsByControlDomainCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListControlDomainInsightsByAssessmentCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListControlDomainInsightsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListControlInsightsByControlDomainCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +224 -0
- package/dist-types/ts3.4/pagination/ListAssessmentControlInsightsByControlDomainPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListControlDomainInsightsByAssessmentPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListControlDomainInsightsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListControlInsightsByControlDomainPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +18 -0
- package/package.json +36 -43
|
@@ -1848,7 +1848,7 @@ export declare namespace DeleteAssessmentResponse {
|
|
|
1848
1848
|
}
|
|
1849
1849
|
export interface DeleteAssessmentFrameworkRequest {
|
|
1850
1850
|
/**
|
|
1851
|
-
* <p> The identifier for the framework. </p>
|
|
1851
|
+
* <p> The identifier for the custom framework. </p>
|
|
1852
1852
|
*/
|
|
1853
1853
|
frameworkId: string | undefined;
|
|
1854
1854
|
}
|
|
@@ -1896,7 +1896,7 @@ export declare namespace DeleteAssessmentFrameworkShareResponse {
|
|
|
1896
1896
|
}
|
|
1897
1897
|
export interface DeleteAssessmentReportRequest {
|
|
1898
1898
|
/**
|
|
1899
|
-
* <p> The identifier for the assessment. </p>
|
|
1899
|
+
* <p> The unique identifier for the assessment. </p>
|
|
1900
1900
|
*/
|
|
1901
1901
|
assessmentId: string | undefined;
|
|
1902
1902
|
/**
|
|
@@ -1920,7 +1920,7 @@ export declare namespace DeleteAssessmentReportResponse {
|
|
|
1920
1920
|
}
|
|
1921
1921
|
export interface DeleteControlRequest {
|
|
1922
1922
|
/**
|
|
1923
|
-
* <p> The identifier for the control. </p>
|
|
1923
|
+
* <p> The unique identifier for the control. </p>
|
|
1924
1924
|
*/
|
|
1925
1925
|
controlId: string | undefined;
|
|
1926
1926
|
}
|
|
@@ -1980,11 +1980,11 @@ export declare namespace DeregisterOrganizationAdminAccountResponse {
|
|
|
1980
1980
|
}
|
|
1981
1981
|
export interface DisassociateAssessmentReportEvidenceFolderRequest {
|
|
1982
1982
|
/**
|
|
1983
|
-
* <p> The identifier for the assessment. </p>
|
|
1983
|
+
* <p> The unique identifier for the assessment. </p>
|
|
1984
1984
|
*/
|
|
1985
1985
|
assessmentId: string | undefined;
|
|
1986
1986
|
/**
|
|
1987
|
-
* <p> The identifier for the folder
|
|
1987
|
+
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
1988
1988
|
*/
|
|
1989
1989
|
evidenceFolderId: string | undefined;
|
|
1990
1990
|
}
|
|
@@ -2024,7 +2024,7 @@ export declare namespace GetAccountStatusResponse {
|
|
|
2024
2024
|
}
|
|
2025
2025
|
export interface GetAssessmentRequest {
|
|
2026
2026
|
/**
|
|
2027
|
-
* <p>
|
|
2027
|
+
* <p>The unique identifier for the assessment. </p>
|
|
2028
2028
|
*/
|
|
2029
2029
|
assessmentId: string | undefined;
|
|
2030
2030
|
}
|
|
@@ -2080,11 +2080,11 @@ export declare namespace GetAssessmentFrameworkResponse {
|
|
|
2080
2080
|
}
|
|
2081
2081
|
export interface GetAssessmentReportUrlRequest {
|
|
2082
2082
|
/**
|
|
2083
|
-
* <p> The identifier for the assessment report. </p>
|
|
2083
|
+
* <p> The unique identifier for the assessment report. </p>
|
|
2084
2084
|
*/
|
|
2085
2085
|
assessmentReportId: string | undefined;
|
|
2086
2086
|
/**
|
|
2087
|
-
* <p> The identifier for the assessment. </p>
|
|
2087
|
+
* <p> The unique identifier for the assessment. </p>
|
|
2088
2088
|
*/
|
|
2089
2089
|
assessmentId: string | undefined;
|
|
2090
2090
|
}
|
|
@@ -2129,15 +2129,15 @@ export declare namespace GetAssessmentReportUrlResponse {
|
|
|
2129
2129
|
}
|
|
2130
2130
|
export interface GetChangeLogsRequest {
|
|
2131
2131
|
/**
|
|
2132
|
-
* <p>
|
|
2132
|
+
* <p>The unique identifier for the assessment. </p>
|
|
2133
2133
|
*/
|
|
2134
2134
|
assessmentId: string | undefined;
|
|
2135
2135
|
/**
|
|
2136
|
-
* <p> The identifier for the control set. </p>
|
|
2136
|
+
* <p> The unique identifier for the control set. </p>
|
|
2137
2137
|
*/
|
|
2138
2138
|
controlSetId?: string;
|
|
2139
2139
|
/**
|
|
2140
|
-
* <p> The identifier for the control. </p>
|
|
2140
|
+
* <p> The unique identifier for the control. </p>
|
|
2141
2141
|
*/
|
|
2142
2142
|
controlId?: string;
|
|
2143
2143
|
/**
|
|
@@ -2145,7 +2145,7 @@ export interface GetChangeLogsRequest {
|
|
|
2145
2145
|
*/
|
|
2146
2146
|
nextToken?: string;
|
|
2147
2147
|
/**
|
|
2148
|
-
* <p>
|
|
2148
|
+
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
2149
2149
|
*/
|
|
2150
2150
|
maxResults?: number;
|
|
2151
2151
|
}
|
|
@@ -2197,11 +2197,11 @@ export declare namespace ChangeLog {
|
|
|
2197
2197
|
}
|
|
2198
2198
|
export interface GetChangeLogsResponse {
|
|
2199
2199
|
/**
|
|
2200
|
-
* <p>
|
|
2200
|
+
* <p>The list of user activity for the control. </p>
|
|
2201
2201
|
*/
|
|
2202
2202
|
changeLogs?: ChangeLog[];
|
|
2203
2203
|
/**
|
|
2204
|
-
* <p>
|
|
2204
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
2205
2205
|
*/
|
|
2206
2206
|
nextToken?: string;
|
|
2207
2207
|
}
|
|
@@ -2308,19 +2308,19 @@ export declare namespace GetDelegationsResponse {
|
|
|
2308
2308
|
}
|
|
2309
2309
|
export interface GetEvidenceRequest {
|
|
2310
2310
|
/**
|
|
2311
|
-
* <p> The identifier for the assessment. </p>
|
|
2311
|
+
* <p> The unique identifier for the assessment. </p>
|
|
2312
2312
|
*/
|
|
2313
2313
|
assessmentId: string | undefined;
|
|
2314
2314
|
/**
|
|
2315
|
-
* <p> The identifier for the control set. </p>
|
|
2315
|
+
* <p> The unique identifier for the control set. </p>
|
|
2316
2316
|
*/
|
|
2317
2317
|
controlSetId: string | undefined;
|
|
2318
2318
|
/**
|
|
2319
|
-
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
2319
|
+
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2320
2320
|
*/
|
|
2321
2321
|
evidenceFolderId: string | undefined;
|
|
2322
2322
|
/**
|
|
2323
|
-
* <p> The identifier for the evidence. </p>
|
|
2323
|
+
* <p> The unique identifier for the evidence. </p>
|
|
2324
2324
|
*/
|
|
2325
2325
|
evidenceId: string | undefined;
|
|
2326
2326
|
}
|
|
@@ -2490,15 +2490,15 @@ export declare namespace GetEvidenceByEvidenceFolderResponse {
|
|
|
2490
2490
|
}
|
|
2491
2491
|
export interface GetEvidenceFolderRequest {
|
|
2492
2492
|
/**
|
|
2493
|
-
* <p> The identifier for the assessment. </p>
|
|
2493
|
+
* <p> The unique identifier for the assessment. </p>
|
|
2494
2494
|
*/
|
|
2495
2495
|
assessmentId: string | undefined;
|
|
2496
2496
|
/**
|
|
2497
|
-
* <p> The identifier for the control set. </p>
|
|
2497
|
+
* <p> The unique identifier for the control set. </p>
|
|
2498
2498
|
*/
|
|
2499
2499
|
controlSetId: string | undefined;
|
|
2500
2500
|
/**
|
|
2501
|
-
* <p> The identifier for the folder that the evidence is stored in. </p>
|
|
2501
|
+
* <p> The unique identifier for the folder that the evidence is stored in. </p>
|
|
2502
2502
|
*/
|
|
2503
2503
|
evidenceFolderId: string | undefined;
|
|
2504
2504
|
}
|
|
@@ -2522,7 +2522,7 @@ export declare namespace GetEvidenceFolderResponse {
|
|
|
2522
2522
|
}
|
|
2523
2523
|
export interface GetEvidenceFoldersByAssessmentRequest {
|
|
2524
2524
|
/**
|
|
2525
|
-
* <p> The identifier for the assessment. </p>
|
|
2525
|
+
* <p> The unique identifier for the assessment. </p>
|
|
2526
2526
|
*/
|
|
2527
2527
|
assessmentId: string | undefined;
|
|
2528
2528
|
/**
|
|
@@ -2602,6 +2602,205 @@ export declare namespace GetEvidenceFoldersByAssessmentControlResponse {
|
|
|
2602
2602
|
*/
|
|
2603
2603
|
const filterSensitiveLog: (obj: GetEvidenceFoldersByAssessmentControlResponse) => any;
|
|
2604
2604
|
}
|
|
2605
|
+
export interface GetInsightsRequest {
|
|
2606
|
+
}
|
|
2607
|
+
export declare namespace GetInsightsRequest {
|
|
2608
|
+
/**
|
|
2609
|
+
* @internal
|
|
2610
|
+
*/
|
|
2611
|
+
const filterSensitiveLog: (obj: GetInsightsRequest) => any;
|
|
2612
|
+
}
|
|
2613
|
+
/**
|
|
2614
|
+
* <p>A summary of the latest analytics data for all your active assessments. </p>
|
|
2615
|
+
* <p>This summary is a snapshot of the data that your active assessments collected on the
|
|
2616
|
+
* <code>lastUpdated</code> date. It’s important to understand that the following totals
|
|
2617
|
+
* are daily counts based on this date — they aren’t a total sum to date. </p>
|
|
2618
|
+
* <p>The <code>Insights</code> data is eventually consistent. This means that, when you read
|
|
2619
|
+
* data from <code>Insights</code>, the response might not instantly reflect the results of a
|
|
2620
|
+
* recently completed write or update operation. If you repeat your read request after a few
|
|
2621
|
+
* hours, the response should return the latest data.</p>
|
|
2622
|
+
* <note>
|
|
2623
|
+
* <p>If you delete an assessment or change its status to inactive,
|
|
2624
|
+
* <code>InsightsByAssessment</code> includes data for that assessment as
|
|
2625
|
+
* follows.</p>
|
|
2626
|
+
* <ul>
|
|
2627
|
+
* <li>
|
|
2628
|
+
* <p>
|
|
2629
|
+
* <b>Inactive assessments</b> - If Audit Manager collected
|
|
2630
|
+
* evidence for your assessment before you changed it inactive, that evidence is
|
|
2631
|
+
* included in the <code>InsightsByAssessment</code> counts for that day.</p>
|
|
2632
|
+
* </li>
|
|
2633
|
+
* <li>
|
|
2634
|
+
* <p>
|
|
2635
|
+
* <b>Deleted assessments</b> - If Audit Manager collected
|
|
2636
|
+
* evidence for your assessment before you deleted it, that evidence isn't included
|
|
2637
|
+
* in the <code>InsightsByAssessment</code> counts for that day.</p>
|
|
2638
|
+
* </li>
|
|
2639
|
+
* </ul>
|
|
2640
|
+
* </note>
|
|
2641
|
+
*/
|
|
2642
|
+
export interface Insights {
|
|
2643
|
+
/**
|
|
2644
|
+
* <p>The number of active assessments in Audit Manager. </p>
|
|
2645
|
+
*/
|
|
2646
|
+
activeAssessmentsCount?: number;
|
|
2647
|
+
/**
|
|
2648
|
+
* <p>The number of compliance check evidence that Audit Manager classified as non-compliant
|
|
2649
|
+
* on the <code>lastUpdated</code> date. This includes evidence that was collected from
|
|
2650
|
+
* Security Hub with a <i>Fail</i> ruling, or collected from
|
|
2651
|
+
* Config with a <i>Non-compliant</i> ruling. </p>
|
|
2652
|
+
*/
|
|
2653
|
+
noncompliantEvidenceCount?: number;
|
|
2654
|
+
/**
|
|
2655
|
+
* <p>The number of compliance check evidence that Audit Manager classified as compliant on
|
|
2656
|
+
* the <code>lastUpdated</code> date. This includes evidence that was collected from Security Hub with a <i>Pass</i> ruling, or collected from Config with a <i>Compliant</i> ruling. </p>
|
|
2657
|
+
*/
|
|
2658
|
+
compliantEvidenceCount?: number;
|
|
2659
|
+
/**
|
|
2660
|
+
* <p>The number of evidence without a compliance check ruling. Evidence is inconclusive when the
|
|
2661
|
+
* associated control uses Security Hub or Config as a data source
|
|
2662
|
+
* but you didn't enable those services. This is also the case when a control uses a data
|
|
2663
|
+
* source that doesn’t support compliance checks (for example: manual evidence, API calls, or
|
|
2664
|
+
* CloudTrail). </p>
|
|
2665
|
+
* <note>
|
|
2666
|
+
* <p>If evidence has a compliance check status of <i>not applicable</i>, it's classed
|
|
2667
|
+
* as <i>inconclusive</i> in <code>Insights</code> data.</p>
|
|
2668
|
+
* </note>
|
|
2669
|
+
*/
|
|
2670
|
+
inconclusiveEvidenceCount?: number;
|
|
2671
|
+
/**
|
|
2672
|
+
* <p>The number of assessment controls that collected non-compliant evidence on the
|
|
2673
|
+
* <code>lastUpdated</code> date. </p>
|
|
2674
|
+
*/
|
|
2675
|
+
assessmentControlsCountByNoncompliantEvidence?: number;
|
|
2676
|
+
/**
|
|
2677
|
+
* <p>The total number of controls across all active assessments. </p>
|
|
2678
|
+
*/
|
|
2679
|
+
totalAssessmentControlsCount?: number;
|
|
2680
|
+
/**
|
|
2681
|
+
* <p>The time when the cross-assessment insights were last updated. </p>
|
|
2682
|
+
*/
|
|
2683
|
+
lastUpdated?: Date;
|
|
2684
|
+
}
|
|
2685
|
+
export declare namespace Insights {
|
|
2686
|
+
/**
|
|
2687
|
+
* @internal
|
|
2688
|
+
*/
|
|
2689
|
+
const filterSensitiveLog: (obj: Insights) => any;
|
|
2690
|
+
}
|
|
2691
|
+
export interface GetInsightsResponse {
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>The analytics data that the <code>GetInsights</code> API returned. </p>
|
|
2694
|
+
*/
|
|
2695
|
+
insights?: Insights;
|
|
2696
|
+
}
|
|
2697
|
+
export declare namespace GetInsightsResponse {
|
|
2698
|
+
/**
|
|
2699
|
+
* @internal
|
|
2700
|
+
*/
|
|
2701
|
+
const filterSensitiveLog: (obj: GetInsightsResponse) => any;
|
|
2702
|
+
}
|
|
2703
|
+
export interface GetInsightsByAssessmentRequest {
|
|
2704
|
+
/**
|
|
2705
|
+
* <p>The unique identifier for the assessment. </p>
|
|
2706
|
+
*/
|
|
2707
|
+
assessmentId: string | undefined;
|
|
2708
|
+
}
|
|
2709
|
+
export declare namespace GetInsightsByAssessmentRequest {
|
|
2710
|
+
/**
|
|
2711
|
+
* @internal
|
|
2712
|
+
*/
|
|
2713
|
+
const filterSensitiveLog: (obj: GetInsightsByAssessmentRequest) => any;
|
|
2714
|
+
}
|
|
2715
|
+
/**
|
|
2716
|
+
* <p>A summary of the latest analytics data for a specific active assessment.</p>
|
|
2717
|
+
* <p>This summary is a snapshot of the data that was collected on the <code>lastUpdated</code>
|
|
2718
|
+
* date. It’s important to understand that the totals in <code>InsightsByAssessment</code> are
|
|
2719
|
+
* daily counts based on this date — they aren’t a total sum to date. </p>
|
|
2720
|
+
* <p>The <code>InsightsByAssessment</code> data is eventually consistent. This means that
|
|
2721
|
+
* when you read data from <code>InsightsByAssessment</code>, the response might not instantly
|
|
2722
|
+
* reflect the results of a recently completed write or update operation. If you repeat your
|
|
2723
|
+
* read request after a few hours, the response returns the latest data.</p>
|
|
2724
|
+
* <note>
|
|
2725
|
+
* <p>If you delete an assessment or change its status to inactive,
|
|
2726
|
+
* <code>InsightsByAssessment</code> includes data for that assessment as
|
|
2727
|
+
* follows.</p>
|
|
2728
|
+
* <ul>
|
|
2729
|
+
* <li>
|
|
2730
|
+
* <p>
|
|
2731
|
+
* <b>Inactive assessments</b> - If Audit Manager collected
|
|
2732
|
+
* evidence for your assessment before you changed it inactive, that evidence is
|
|
2733
|
+
* included in the <code>InsightsByAssessment</code> counts for that day.</p>
|
|
2734
|
+
* </li>
|
|
2735
|
+
* <li>
|
|
2736
|
+
* <p>
|
|
2737
|
+
* <b>Deleted assessments</b> - If Audit Manager collected
|
|
2738
|
+
* evidence for your assessment before you deleted it, that evidence isn't included
|
|
2739
|
+
* in the <code>InsightsByAssessment</code> counts for that day.</p>
|
|
2740
|
+
* </li>
|
|
2741
|
+
* </ul>
|
|
2742
|
+
* </note>
|
|
2743
|
+
*/
|
|
2744
|
+
export interface InsightsByAssessment {
|
|
2745
|
+
/**
|
|
2746
|
+
* <p>The number of compliance check evidence that Audit Manager classified as non-compliant.
|
|
2747
|
+
* This includes evidence that was collected from Security Hub with a
|
|
2748
|
+
* <i>Fail</i> ruling, or collected from Config with a
|
|
2749
|
+
* <i>Non-compliant</i> ruling. </p>
|
|
2750
|
+
*/
|
|
2751
|
+
noncompliantEvidenceCount?: number;
|
|
2752
|
+
/**
|
|
2753
|
+
* <p>The number of compliance check evidence that Audit Manager classified as compliant.
|
|
2754
|
+
* This includes evidence that was collected from Security Hub with a
|
|
2755
|
+
* <i>Pass</i> ruling, or collected from Config with a
|
|
2756
|
+
* <i>Compliant</i> ruling. </p>
|
|
2757
|
+
*/
|
|
2758
|
+
compliantEvidenceCount?: number;
|
|
2759
|
+
/**
|
|
2760
|
+
* <p>The amount of evidence without a compliance check ruling. Evidence is inconclusive if the
|
|
2761
|
+
* associated control uses Security Hub or Config as a data source
|
|
2762
|
+
* and you didn't enable those services. This is also the case if a control uses a data source
|
|
2763
|
+
* that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail). </p>
|
|
2764
|
+
* <note>
|
|
2765
|
+
* <p>If evidence has a compliance check status of <i>not applicable</i>, it's
|
|
2766
|
+
* classified as <i>inconclusive</i> in <code>InsightsByAssessment</code>
|
|
2767
|
+
* data.</p>
|
|
2768
|
+
* </note>
|
|
2769
|
+
*/
|
|
2770
|
+
inconclusiveEvidenceCount?: number;
|
|
2771
|
+
/**
|
|
2772
|
+
* <p>The number of assessment controls that collected non-compliant evidence on the
|
|
2773
|
+
* <code>lastUpdated</code> date. </p>
|
|
2774
|
+
*/
|
|
2775
|
+
assessmentControlsCountByNoncompliantEvidence?: number;
|
|
2776
|
+
/**
|
|
2777
|
+
* <p>The total number of controls in the assessment. </p>
|
|
2778
|
+
*/
|
|
2779
|
+
totalAssessmentControlsCount?: number;
|
|
2780
|
+
/**
|
|
2781
|
+
* <p>The time when the assessment insights were last updated.</p>
|
|
2782
|
+
*/
|
|
2783
|
+
lastUpdated?: Date;
|
|
2784
|
+
}
|
|
2785
|
+
export declare namespace InsightsByAssessment {
|
|
2786
|
+
/**
|
|
2787
|
+
* @internal
|
|
2788
|
+
*/
|
|
2789
|
+
const filterSensitiveLog: (obj: InsightsByAssessment) => any;
|
|
2790
|
+
}
|
|
2791
|
+
export interface GetInsightsByAssessmentResponse {
|
|
2792
|
+
/**
|
|
2793
|
+
* <p> The assessment analytics data that the <code>GetInsightsByAssessment</code> API
|
|
2794
|
+
* returned. </p>
|
|
2795
|
+
*/
|
|
2796
|
+
insights?: InsightsByAssessment;
|
|
2797
|
+
}
|
|
2798
|
+
export declare namespace GetInsightsByAssessmentResponse {
|
|
2799
|
+
/**
|
|
2800
|
+
* @internal
|
|
2801
|
+
*/
|
|
2802
|
+
const filterSensitiveLog: (obj: GetInsightsByAssessmentResponse) => any;
|
|
2803
|
+
}
|
|
2605
2804
|
export interface GetOrganizationAdminAccountRequest {
|
|
2606
2805
|
}
|
|
2607
2806
|
export declare namespace GetOrganizationAdminAccountRequest {
|
|
@@ -2736,6 +2935,120 @@ export declare namespace GetSettingsResponse {
|
|
|
2736
2935
|
*/
|
|
2737
2936
|
const filterSensitiveLog: (obj: GetSettingsResponse) => any;
|
|
2738
2937
|
}
|
|
2938
|
+
export interface ListAssessmentControlInsightsByControlDomainRequest {
|
|
2939
|
+
/**
|
|
2940
|
+
* <p>The unique identifier for the control domain. </p>
|
|
2941
|
+
*/
|
|
2942
|
+
controlDomainId: string | undefined;
|
|
2943
|
+
/**
|
|
2944
|
+
* <p>The unique identifier for the active assessment. </p>
|
|
2945
|
+
*/
|
|
2946
|
+
assessmentId: string | undefined;
|
|
2947
|
+
/**
|
|
2948
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
2949
|
+
*/
|
|
2950
|
+
nextToken?: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
2953
|
+
*/
|
|
2954
|
+
maxResults?: number;
|
|
2955
|
+
}
|
|
2956
|
+
export declare namespace ListAssessmentControlInsightsByControlDomainRequest {
|
|
2957
|
+
/**
|
|
2958
|
+
* @internal
|
|
2959
|
+
*/
|
|
2960
|
+
const filterSensitiveLog: (obj: ListAssessmentControlInsightsByControlDomainRequest) => any;
|
|
2961
|
+
}
|
|
2962
|
+
/**
|
|
2963
|
+
* <p>A breakdown of the latest compliance check status for the evidence in your Audit Manager
|
|
2964
|
+
* assessments. </p>
|
|
2965
|
+
*/
|
|
2966
|
+
export interface EvidenceInsights {
|
|
2967
|
+
/**
|
|
2968
|
+
* <p>The number of compliance check evidence that Audit Manager classified as non-compliant.
|
|
2969
|
+
* This includes evidence that was collected from Security Hub with a
|
|
2970
|
+
* <i>Fail</i> ruling, or collected from Config with a
|
|
2971
|
+
* <i>Non-compliant</i> ruling. </p>
|
|
2972
|
+
*/
|
|
2973
|
+
noncompliantEvidenceCount?: number;
|
|
2974
|
+
/**
|
|
2975
|
+
* <p>The number of compliance check evidence that Audit Manager classified as compliant. This
|
|
2976
|
+
* includes evidence that was collected from Security Hub with a
|
|
2977
|
+
* <i>Pass</i> ruling, or collected from Config with a
|
|
2978
|
+
* <i>Compliant</i> ruling. </p>
|
|
2979
|
+
*/
|
|
2980
|
+
compliantEvidenceCount?: number;
|
|
2981
|
+
/**
|
|
2982
|
+
* <p>The number of evidence that a compliance check ruling isn't available for. Evidence is
|
|
2983
|
+
* 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
|
|
2984
|
+
* control uses a data source that doesn’t support compliance checks (for example, manual
|
|
2985
|
+
* evidence, API calls, or CloudTrail). </p>
|
|
2986
|
+
* <note>
|
|
2987
|
+
* <p>If evidence has a compliance check status of <i>not applicable</i> in the
|
|
2988
|
+
* console, it's classified as <i>inconclusive</i> in
|
|
2989
|
+
* <code>EvidenceInsights</code> data.</p>
|
|
2990
|
+
* </note>
|
|
2991
|
+
*/
|
|
2992
|
+
inconclusiveEvidenceCount?: number;
|
|
2993
|
+
}
|
|
2994
|
+
export declare namespace EvidenceInsights {
|
|
2995
|
+
/**
|
|
2996
|
+
* @internal
|
|
2997
|
+
*/
|
|
2998
|
+
const filterSensitiveLog: (obj: EvidenceInsights) => any;
|
|
2999
|
+
}
|
|
3000
|
+
/**
|
|
3001
|
+
* <p>A summary of the latest analytics data for a specific control in a specific active
|
|
3002
|
+
* assessment.</p>
|
|
3003
|
+
* <p>Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.
|
|
3004
|
+
* </p>
|
|
3005
|
+
*/
|
|
3006
|
+
export interface ControlInsightsMetadataByAssessmentItem {
|
|
3007
|
+
/**
|
|
3008
|
+
* <p>The name of the assessment control. </p>
|
|
3009
|
+
*/
|
|
3010
|
+
name?: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* <p>The unique identifier for the assessment control. </p>
|
|
3013
|
+
*/
|
|
3014
|
+
id?: string;
|
|
3015
|
+
/**
|
|
3016
|
+
* <p>A breakdown of the compliance check status for the evidence that’s associated with the
|
|
3017
|
+
* assessment control. </p>
|
|
3018
|
+
*/
|
|
3019
|
+
evidenceInsights?: EvidenceInsights;
|
|
3020
|
+
/**
|
|
3021
|
+
* <p>The name of the control set that the assessment control belongs to. </p>
|
|
3022
|
+
*/
|
|
3023
|
+
controlSetName?: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* <p>The time when the assessment control insights were last updated. </p>
|
|
3026
|
+
*/
|
|
3027
|
+
lastUpdated?: Date;
|
|
3028
|
+
}
|
|
3029
|
+
export declare namespace ControlInsightsMetadataByAssessmentItem {
|
|
3030
|
+
/**
|
|
3031
|
+
* @internal
|
|
3032
|
+
*/
|
|
3033
|
+
const filterSensitiveLog: (obj: ControlInsightsMetadataByAssessmentItem) => any;
|
|
3034
|
+
}
|
|
3035
|
+
export interface ListAssessmentControlInsightsByControlDomainResponse {
|
|
3036
|
+
/**
|
|
3037
|
+
* <p>The assessment control analytics data that the
|
|
3038
|
+
* <code>ListAssessmentControlInsightsByControlDomain</code> API returned. </p>
|
|
3039
|
+
*/
|
|
3040
|
+
controlInsightsByAssessment?: ControlInsightsMetadataByAssessmentItem[];
|
|
3041
|
+
/**
|
|
3042
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3043
|
+
*/
|
|
3044
|
+
nextToken?: string;
|
|
3045
|
+
}
|
|
3046
|
+
export declare namespace ListAssessmentControlInsightsByControlDomainResponse {
|
|
3047
|
+
/**
|
|
3048
|
+
* @internal
|
|
3049
|
+
*/
|
|
3050
|
+
const filterSensitiveLog: (obj: ListAssessmentControlInsightsByControlDomainResponse) => any;
|
|
3051
|
+
}
|
|
2739
3052
|
export interface ListAssessmentFrameworksRequest {
|
|
2740
3053
|
/**
|
|
2741
3054
|
* <p> The type of framework, such as a standard framework or a custom framework. </p>
|
|
@@ -2843,6 +3156,10 @@ export declare namespace ListAssessmentReportsResponse {
|
|
|
2843
3156
|
const filterSensitiveLog: (obj: ListAssessmentReportsResponse) => any;
|
|
2844
3157
|
}
|
|
2845
3158
|
export interface ListAssessmentsRequest {
|
|
3159
|
+
/**
|
|
3160
|
+
* <p> The current status of the assessment.</p>
|
|
3161
|
+
*/
|
|
3162
|
+
status?: AssessmentStatus | string;
|
|
2846
3163
|
/**
|
|
2847
3164
|
* <p> The pagination token that's used to fetch the next set of results. </p>
|
|
2848
3165
|
*/
|
|
@@ -2874,6 +3191,180 @@ export declare namespace ListAssessmentsResponse {
|
|
|
2874
3191
|
*/
|
|
2875
3192
|
const filterSensitiveLog: (obj: ListAssessmentsResponse) => any;
|
|
2876
3193
|
}
|
|
3194
|
+
export interface ListControlDomainInsightsRequest {
|
|
3195
|
+
/**
|
|
3196
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3197
|
+
*/
|
|
3198
|
+
nextToken?: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3201
|
+
*/
|
|
3202
|
+
maxResults?: number;
|
|
3203
|
+
}
|
|
3204
|
+
export declare namespace ListControlDomainInsightsRequest {
|
|
3205
|
+
/**
|
|
3206
|
+
* @internal
|
|
3207
|
+
*/
|
|
3208
|
+
const filterSensitiveLog: (obj: ListControlDomainInsightsRequest) => any;
|
|
3209
|
+
}
|
|
3210
|
+
/**
|
|
3211
|
+
* <p>A summary of the latest analytics data for a specific control domain.</p>
|
|
3212
|
+
* <p>Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.</p>
|
|
3213
|
+
*/
|
|
3214
|
+
export interface ControlDomainInsights {
|
|
3215
|
+
/**
|
|
3216
|
+
* <p>The name of the control domain. </p>
|
|
3217
|
+
*/
|
|
3218
|
+
name?: string;
|
|
3219
|
+
/**
|
|
3220
|
+
* <p>The unique identifier for the control domain. </p>
|
|
3221
|
+
*/
|
|
3222
|
+
id?: string;
|
|
3223
|
+
/**
|
|
3224
|
+
* <p>The number of controls in the control domain that collected non-compliant evidence on the
|
|
3225
|
+
* <code>lastUpdated</code> date. </p>
|
|
3226
|
+
*/
|
|
3227
|
+
controlsCountByNoncompliantEvidence?: number;
|
|
3228
|
+
/**
|
|
3229
|
+
* <p>The total number of controls in the control domain. </p>
|
|
3230
|
+
*/
|
|
3231
|
+
totalControlsCount?: number;
|
|
3232
|
+
/**
|
|
3233
|
+
* <p>A breakdown of the compliance check status for the evidence that’s associated with the control
|
|
3234
|
+
* domain. </p>
|
|
3235
|
+
*/
|
|
3236
|
+
evidenceInsights?: EvidenceInsights;
|
|
3237
|
+
/**
|
|
3238
|
+
* <p>The time when the control domain insights were last updated. </p>
|
|
3239
|
+
*/
|
|
3240
|
+
lastUpdated?: Date;
|
|
3241
|
+
}
|
|
3242
|
+
export declare namespace ControlDomainInsights {
|
|
3243
|
+
/**
|
|
3244
|
+
* @internal
|
|
3245
|
+
*/
|
|
3246
|
+
const filterSensitiveLog: (obj: ControlDomainInsights) => any;
|
|
3247
|
+
}
|
|
3248
|
+
export interface ListControlDomainInsightsResponse {
|
|
3249
|
+
/**
|
|
3250
|
+
* <p>The control domain analytics data that the <code>ListControlDomainInsights</code> API
|
|
3251
|
+
* returned. </p>
|
|
3252
|
+
*/
|
|
3253
|
+
controlDomainInsights?: ControlDomainInsights[];
|
|
3254
|
+
/**
|
|
3255
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3256
|
+
*/
|
|
3257
|
+
nextToken?: string;
|
|
3258
|
+
}
|
|
3259
|
+
export declare namespace ListControlDomainInsightsResponse {
|
|
3260
|
+
/**
|
|
3261
|
+
* @internal
|
|
3262
|
+
*/
|
|
3263
|
+
const filterSensitiveLog: (obj: ListControlDomainInsightsResponse) => any;
|
|
3264
|
+
}
|
|
3265
|
+
export interface ListControlDomainInsightsByAssessmentRequest {
|
|
3266
|
+
/**
|
|
3267
|
+
* <p>The unique identifier for the active assessment. </p>
|
|
3268
|
+
*/
|
|
3269
|
+
assessmentId: string | undefined;
|
|
3270
|
+
/**
|
|
3271
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3272
|
+
*/
|
|
3273
|
+
nextToken?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3276
|
+
*/
|
|
3277
|
+
maxResults?: number;
|
|
3278
|
+
}
|
|
3279
|
+
export declare namespace ListControlDomainInsightsByAssessmentRequest {
|
|
3280
|
+
/**
|
|
3281
|
+
* @internal
|
|
3282
|
+
*/
|
|
3283
|
+
const filterSensitiveLog: (obj: ListControlDomainInsightsByAssessmentRequest) => any;
|
|
3284
|
+
}
|
|
3285
|
+
export interface ListControlDomainInsightsByAssessmentResponse {
|
|
3286
|
+
/**
|
|
3287
|
+
* <p>The control domain analytics data that the
|
|
3288
|
+
* <code>ListControlDomainInsightsByAssessment</code> API returned. </p>
|
|
3289
|
+
*/
|
|
3290
|
+
controlDomainInsights?: ControlDomainInsights[];
|
|
3291
|
+
/**
|
|
3292
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3293
|
+
*/
|
|
3294
|
+
nextToken?: string;
|
|
3295
|
+
}
|
|
3296
|
+
export declare namespace ListControlDomainInsightsByAssessmentResponse {
|
|
3297
|
+
/**
|
|
3298
|
+
* @internal
|
|
3299
|
+
*/
|
|
3300
|
+
const filterSensitiveLog: (obj: ListControlDomainInsightsByAssessmentResponse) => any;
|
|
3301
|
+
}
|
|
3302
|
+
export interface ListControlInsightsByControlDomainRequest {
|
|
3303
|
+
/**
|
|
3304
|
+
* <p>The unique identifier for the control domain. </p>
|
|
3305
|
+
*/
|
|
3306
|
+
controlDomainId: string | undefined;
|
|
3307
|
+
/**
|
|
3308
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3309
|
+
*/
|
|
3310
|
+
nextToken?: string;
|
|
3311
|
+
/**
|
|
3312
|
+
* <p>Represents the maximum number of results on a page or for an API request call. </p>
|
|
3313
|
+
*/
|
|
3314
|
+
maxResults?: number;
|
|
3315
|
+
}
|
|
3316
|
+
export declare namespace ListControlInsightsByControlDomainRequest {
|
|
3317
|
+
/**
|
|
3318
|
+
* @internal
|
|
3319
|
+
*/
|
|
3320
|
+
const filterSensitiveLog: (obj: ListControlInsightsByControlDomainRequest) => any;
|
|
3321
|
+
}
|
|
3322
|
+
/**
|
|
3323
|
+
* <p>A summary of the latest analytics data for a specific control. </p>
|
|
3324
|
+
* <p>This data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.</p>
|
|
3325
|
+
*/
|
|
3326
|
+
export interface ControlInsightsMetadataItem {
|
|
3327
|
+
/**
|
|
3328
|
+
* <p>The name of the control. </p>
|
|
3329
|
+
*/
|
|
3330
|
+
name?: string;
|
|
3331
|
+
/**
|
|
3332
|
+
* <p>The unique identifier for the control. </p>
|
|
3333
|
+
*/
|
|
3334
|
+
id?: string;
|
|
3335
|
+
/**
|
|
3336
|
+
* <p>A breakdown of the compliance check status for the evidence that’s associated with the
|
|
3337
|
+
* control. </p>
|
|
3338
|
+
*/
|
|
3339
|
+
evidenceInsights?: EvidenceInsights;
|
|
3340
|
+
/**
|
|
3341
|
+
* <p>The time when the control insights were last updated. </p>
|
|
3342
|
+
*/
|
|
3343
|
+
lastUpdated?: Date;
|
|
3344
|
+
}
|
|
3345
|
+
export declare namespace ControlInsightsMetadataItem {
|
|
3346
|
+
/**
|
|
3347
|
+
* @internal
|
|
3348
|
+
*/
|
|
3349
|
+
const filterSensitiveLog: (obj: ControlInsightsMetadataItem) => any;
|
|
3350
|
+
}
|
|
3351
|
+
export interface ListControlInsightsByControlDomainResponse {
|
|
3352
|
+
/**
|
|
3353
|
+
* <p>The control analytics data that the <code>ListControlInsightsByControlDomain</code> API
|
|
3354
|
+
* returned. </p>
|
|
3355
|
+
*/
|
|
3356
|
+
controlInsightsMetadata?: ControlInsightsMetadataItem[];
|
|
3357
|
+
/**
|
|
3358
|
+
* <p>The pagination token that's used to fetch the next set of results. </p>
|
|
3359
|
+
*/
|
|
3360
|
+
nextToken?: string;
|
|
3361
|
+
}
|
|
3362
|
+
export declare namespace ListControlInsightsByControlDomainResponse {
|
|
3363
|
+
/**
|
|
3364
|
+
* @internal
|
|
3365
|
+
*/
|
|
3366
|
+
const filterSensitiveLog: (obj: ListControlInsightsByControlDomainResponse) => any;
|
|
3367
|
+
}
|
|
2877
3368
|
export interface ListControlsRequest {
|
|
2878
3369
|
/**
|
|
2879
3370
|
* <p> The type of control, such as a standard control or a custom control. </p>
|
|
@@ -3231,7 +3722,7 @@ export declare namespace UntagResourceResponse {
|
|
|
3231
3722
|
}
|
|
3232
3723
|
export interface UpdateAssessmentRequest {
|
|
3233
3724
|
/**
|
|
3234
|
-
* <p> The identifier for the assessment. </p>
|
|
3725
|
+
* <p> The unique identifier for the assessment. </p>
|
|
3235
3726
|
*/
|
|
3236
3727
|
assessmentId: string | undefined;
|
|
3237
3728
|
/**
|
|
@@ -3277,15 +3768,15 @@ export declare namespace UpdateAssessmentResponse {
|
|
|
3277
3768
|
}
|
|
3278
3769
|
export interface UpdateAssessmentControlRequest {
|
|
3279
3770
|
/**
|
|
3280
|
-
* <p> The identifier for the assessment. </p>
|
|
3771
|
+
* <p> The unique identifier for the assessment. </p>
|
|
3281
3772
|
*/
|
|
3282
3773
|
assessmentId: string | undefined;
|
|
3283
3774
|
/**
|
|
3284
|
-
* <p> The identifier for the control set. </p>
|
|
3775
|
+
* <p> The unique identifier for the control set. </p>
|
|
3285
3776
|
*/
|
|
3286
3777
|
controlSetId: string | undefined;
|
|
3287
3778
|
/**
|
|
3288
|
-
* <p> The identifier for the control. </p>
|
|
3779
|
+
* <p> The unique identifier for the control. </p>
|
|
3289
3780
|
*/
|
|
3290
3781
|
controlId: string | undefined;
|
|
3291
3782
|
/**
|
|
@@ -3318,11 +3809,11 @@ export declare namespace UpdateAssessmentControlResponse {
|
|
|
3318
3809
|
}
|
|
3319
3810
|
export interface UpdateAssessmentControlSetStatusRequest {
|
|
3320
3811
|
/**
|
|
3321
|
-
* <p> The identifier for the assessment. </p>
|
|
3812
|
+
* <p> The unique identifier for the assessment. </p>
|
|
3322
3813
|
*/
|
|
3323
3814
|
assessmentId: string | undefined;
|
|
3324
3815
|
/**
|
|
3325
|
-
* <p> The identifier for the control set. </p>
|
|
3816
|
+
* <p> The unique identifier for the control set. </p>
|
|
3326
3817
|
*/
|
|
3327
3818
|
controlSetId: string | undefined;
|
|
3328
3819
|
/**
|
|
@@ -3378,7 +3869,7 @@ export declare namespace UpdateAssessmentFrameworkControlSet {
|
|
|
3378
3869
|
}
|
|
3379
3870
|
export interface UpdateAssessmentFrameworkRequest {
|
|
3380
3871
|
/**
|
|
3381
|
-
* <p> The identifier for the framework. </p>
|
|
3872
|
+
* <p> The unique identifier for the framework. </p>
|
|
3382
3873
|
*/
|
|
3383
3874
|
frameworkId: string | undefined;
|
|
3384
3875
|
/**
|
|
@@ -3457,7 +3948,7 @@ export declare namespace UpdateAssessmentFrameworkShareResponse {
|
|
|
3457
3948
|
}
|
|
3458
3949
|
export interface UpdateAssessmentStatusRequest {
|
|
3459
3950
|
/**
|
|
3460
|
-
* <p> The identifier for the assessment. </p>
|
|
3951
|
+
* <p> The unique identifier for the assessment. </p>
|
|
3461
3952
|
*/
|
|
3462
3953
|
assessmentId: string | undefined;
|
|
3463
3954
|
/**
|