Skip to content

Commit 11be2e0

Browse files
author
awstools
committed
feat(client-auditmanager): New feature: common controls. When creating custom controls, you can now use pre-grouped AWS data sources based on common compliance themes. Also, the awsServices parameter is deprecated because we now manage services in scope for you. If used, the input is ignored and an empty list is returned.
1 parent 4216496 commit 11be2e0

16 files changed

+365
-70
lines changed

clients/client-auditmanager/src/commands/CreateAssessmentCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,9 @@ export interface CreateAssessmentCommandOutput extends CreateAssessmentResponse,
222222
* 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
223223
* restrictions for Audit Manager</a>.</p>
224224
*
225+
* @throws {@link ThrottlingException} (client fault)
226+
* <p>The request was denied due to request throttling.</p>
227+
*
225228
* @throws {@link ValidationException} (client fault)
226229
* <p> The request has invalid or missing parameters. </p>
227230
*

clients/client-auditmanager/src/commands/CreateAssessmentFrameworkCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment
7878
* // { // Control
7979
* // arn: "STRING_VALUE",
8080
* // id: "STRING_VALUE",
81-
* // type: "Standard" || "Custom",
81+
* // type: "Standard" || "Custom" || "Core",
8282
* // name: "STRING_VALUE",
8383
* // description: "STRING_VALUE",
8484
* // testingInformation: "STRING_VALUE",
@@ -91,7 +91,7 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment
9191
* // sourceName: "STRING_VALUE",
9292
* // sourceDescription: "STRING_VALUE",
9393
* // sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
94-
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
94+
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
9595
* // sourceKeyword: { // SourceKeyword
9696
* // keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
9797
* // keywordValue: "STRING_VALUE",
@@ -107,6 +107,7 @@ export interface CreateAssessmentFrameworkCommandOutput extends CreateAssessment
107107
* // tags: { // TagMap
108108
* // "<keys>": "STRING_VALUE",
109109
* // },
110+
* // state: "ACTIVE" || "END_OF_SUPPORT",
110111
* // },
111112
* // ],
112113
* // },

clients/client-auditmanager/src/commands/CreateControlCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
5151
* sourceName: "STRING_VALUE",
5252
* sourceDescription: "STRING_VALUE",
5353
* sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
54-
* sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
54+
* sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
5555
* sourceKeyword: { // SourceKeyword
5656
* keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
5757
* keywordValue: "STRING_VALUE",
@@ -70,7 +70,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
7070
* // control: { // Control
7171
* // arn: "STRING_VALUE",
7272
* // id: "STRING_VALUE",
73-
* // type: "Standard" || "Custom",
73+
* // type: "Standard" || "Custom" || "Core",
7474
* // name: "STRING_VALUE",
7575
* // description: "STRING_VALUE",
7676
* // testingInformation: "STRING_VALUE",
@@ -83,7 +83,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
8383
* // sourceName: "STRING_VALUE",
8484
* // sourceDescription: "STRING_VALUE",
8585
* // sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
86-
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
86+
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
8787
* // sourceKeyword: { // SourceKeyword
8888
* // keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
8989
* // keywordValue: "STRING_VALUE",
@@ -99,6 +99,7 @@ export interface CreateControlCommandOutput extends CreateControlResponse, __Met
9999
* // tags: { // TagMap
100100
* // "<keys>": "STRING_VALUE",
101101
* // },
102+
* // state: "ACTIVE" || "END_OF_SUPPORT",
102103
* // },
103104
* // };
104105
*

clients/client-auditmanager/src/commands/GetAssessmentFrameworkCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew
6262
* // { // Control
6363
* // arn: "STRING_VALUE",
6464
* // id: "STRING_VALUE",
65-
* // type: "Standard" || "Custom",
65+
* // type: "Standard" || "Custom" || "Core",
6666
* // name: "STRING_VALUE",
6767
* // description: "STRING_VALUE",
6868
* // testingInformation: "STRING_VALUE",
@@ -75,7 +75,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew
7575
* // sourceName: "STRING_VALUE",
7676
* // sourceDescription: "STRING_VALUE",
7777
* // sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
78-
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
78+
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
7979
* // sourceKeyword: { // SourceKeyword
8080
* // keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
8181
* // keywordValue: "STRING_VALUE",
@@ -91,6 +91,7 @@ export interface GetAssessmentFrameworkCommandOutput extends GetAssessmentFramew
9191
* // tags: { // TagMap
9292
* // "<keys>": "STRING_VALUE",
9393
* // },
94+
* // state: "ACTIVE" || "END_OF_SUPPORT",
9495
* // },
9596
* // ],
9697
* // },

clients/client-auditmanager/src/commands/GetControlCommand.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
4444
* // control: { // Control
4545
* // arn: "STRING_VALUE",
4646
* // id: "STRING_VALUE",
47-
* // type: "Standard" || "Custom",
47+
* // type: "Standard" || "Custom" || "Core",
4848
* // name: "STRING_VALUE",
4949
* // description: "STRING_VALUE",
5050
* // testingInformation: "STRING_VALUE",
@@ -57,7 +57,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
5757
* // sourceName: "STRING_VALUE",
5858
* // sourceDescription: "STRING_VALUE",
5959
* // sourceSetUpOption: "System_Controls_Mapping" || "Procedural_Controls_Mapping",
60-
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL",
60+
* // sourceType: "AWS_Cloudtrail" || "AWS_Config" || "AWS_Security_Hub" || "AWS_API_Call" || "MANUAL" || "Common_Control" || "Core_Control",
6161
* // sourceKeyword: { // SourceKeyword
6262
* // keywordInputType: "SELECT_FROM_LIST" || "UPLOAD_FILE" || "INPUT_TEXT",
6363
* // keywordValue: "STRING_VALUE",
@@ -73,6 +73,7 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
7373
* // tags: { // TagMap
7474
* // "<keys>": "STRING_VALUE",
7575
* // },
76+
* // state: "ACTIVE" || "END_OF_SUPPORT",
7677
* // },
7778
* // };
7879
*

clients/client-auditmanager/src/commands/GetServicesInScopeCommand.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,18 @@ export interface GetServicesInScopeCommandInput extends GetServicesInScopeReques
2828
export interface GetServicesInScopeCommandOutput extends GetServicesInScopeResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets a list of all of the Amazon Web Services that you can choose to include in
32-
* your assessment. When you <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_CreateAssessment.html">create an assessment</a>, specify which of these services you want to include to
33-
* narrow the assessment's <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_Scope.html">scope</a>.</p>
31+
* <p>Gets a list of the Amazon Web Services from which Audit Manager can collect
32+
* evidence. </p>
33+
* <p>Audit Manager defines which Amazon Web Services are in scope for an
34+
* assessment. Audit Manager infers this scope by examining the assessment’s controls and
35+
* their data sources, and then mapping this information to one or more of the corresponding
36+
* Amazon Web Services that are in this list.</p>
37+
* <note>
38+
* <p>For information about why it's no longer possible to specify services in scope manually, see
39+
* <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-collection-issues.html#unable-to-edit-services">I can't edit the services in scope for my assessment</a> in
40+
* the <i>Troubleshooting</i> section of the Audit Manager user
41+
* guide.</p>
42+
* </note>
3443
* @example
3544
* Use a bare-bones client and the command you need to make an API call.
3645
* ```javascript

clients/client-auditmanager/src/commands/ListControlDomainInsightsByAssessmentCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ export interface ListControlDomainInsightsByAssessmentCommandOutput
3838

3939
/**
4040
* <p>Lists analytics data for control domains within a specified active assessment.</p>
41+
* <p>Audit Manager supports the control domains that are provided by Amazon Web Services
42+
* Control Catalog. For information about how to find a list of available control domains, see
43+
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html">
44+
* <code>ListDomains</code>
45+
* </a> in the Amazon Web Services Control
46+
* Catalog API Reference.</p>
4147
* <note>
4248
* <p>A control domain is listed only if at least one of the controls within that domain
4349
* collected evidence on the <code>lastUpdated</code> date of

clients/client-auditmanager/src/commands/ListControlDomainInsightsCommand.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ export interface ListControlDomainInsightsCommandOutput extends ListControlDomai
3030
/**
3131
* <p>Lists the latest analytics data for control domains across all of your active
3232
* assessments. </p>
33+
* <p>Audit Manager supports the control domains that are provided by Amazon Web Services
34+
* Control Catalog. For information about how to find a list of available control domains, see
35+
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_ListDomains.html">
36+
* <code>ListDomains</code>
37+
* </a> in the Amazon Web Services Control
38+
* Catalog API Reference.</p>
3339
* <note>
3440
* <p>A control domain is listed only if at least one of the controls within that domain
3541
* collected evidence on the <code>lastUpdated</code> date of

clients/client-auditmanager/src/commands/ListControlsCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ export interface ListControlsCommandOutput extends ListControlsResponse, __Metad
3636
* // const { AuditManagerClient, ListControlsCommand } = require("@aws-sdk/client-auditmanager"); // CommonJS import
3737
* const client = new AuditManagerClient(config);
3838
* const input = { // ListControlsRequest
39-
* controlType: "Standard" || "Custom", // required
39+
* controlType: "Standard" || "Custom" || "Core", // required
4040
* nextToken: "STRING_VALUE",
4141
* maxResults: Number("int"),
42+
* controlCatalogId: "STRING_VALUE",
4243
* };
4344
* const command = new ListControlsCommand(input);
4445
* const response = await client.send(command);

clients/client-auditmanager/src/commands/ListKeywordsForDataSourceCommand.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface ListKeywordsForDataSourceCommandInput extends ListKeywordsForDa
2828
export interface ListKeywordsForDataSourceCommandOutput extends ListKeywordsForDataSourceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p> Returns a list of keywords that are pre-mapped to the specified control data source.
32-
* </p>
31+
* <p>Returns a list of keywords that are pre-mapped to the specified control data
32+
* source.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

0 commit comments

Comments
 (0)