Skip to content

Commit dbff0ec

Browse files
author
awstools
committed
feat(client-auditmanager): Added a note to Framework APIs (CreateAssessmentFramework, GetAssessmentFramework, UpdateAssessmentFramework) clarifying that the Controls object returns a partial response when called through Framework APIs. Added documentation that the Framework's controlSources parameter is no longer supported.
1 parent 6cc73c6 commit dbff0ec

File tree

3 files changed

+46
-11
lines changed

3 files changed

+46
-11
lines changed

‎clients/client-auditmanager/src/commands/UpdateAssessmentFrameworkCommand.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,12 @@ export interface UpdateAssessmentFrameworkCommandOutput extends UpdateAssessment
140140
* @throws {@link ResourceNotFoundException} (client fault)
141141
* <p> The resource that's specified in the request can't be found. </p>
142142
*
143+
* @throws {@link ServiceQuotaExceededException} (client fault)
144+
* <p>You've reached your account quota for this resource type. To perform the requested
145+
* 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
146+
* 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
147+
* restrictions for Audit Manager</a>.</p>
148+
*
143149
* @throws {@link ValidationException} (client fault)
144150
* <p> The request has invalid or missing parameters. </p>
145151
*

‎clients/client-auditmanager/src/models/models_0.ts‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1885,6 +1885,10 @@ export interface CreateAssessmentFrameworkRequest {
18851885

18861886
/**
18871887
* <p> The control sets that are associated with the framework. </p>
1888+
* <note>
1889+
* <p>The <code>Controls</code> object returns a partial response when called through Framework
1890+
* APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p>
1891+
* </note>
18881892
* @public
18891893
*/
18901894
controlSets: CreateAssessmentFrameworkControlSet[] | undefined;
@@ -2452,12 +2456,22 @@ export interface Framework {
24522456

24532457
/**
24542458
* <p> The control data sources where Audit Manager collects evidence from.</p>
2459+
* <important>
2460+
* <p>This API parameter is no longer supported.</p>
2461+
* </important>
2462+
*
2463+
* @deprecated
24552464
* @public
24562465
*/
24572466
controlSources?: string | undefined;
24582467

24592468
/**
24602469
* <p> The control sets that are associated with the framework. </p>
2470+
* <note>
2471+
* <p>The <code>Controls</code> object returns a partial response when called through
2472+
* Framework APIs. For a complete <code>Controls</code> object, use
2473+
* <code>GetControl</code>.</p>
2474+
* </note>
24612475
* @public
24622476
*/
24632477
controlSets?: ControlSet[] | undefined;
@@ -2498,8 +2512,7 @@ export interface Framework {
24982512
*/
24992513
export interface CreateAssessmentFrameworkResponse {
25002514
/**
2501-
* <p> The name of the new framework that the <code>CreateAssessmentFramework</code> API
2502-
* returned. </p>
2515+
* <p> The new framework object that the <code>CreateAssessmentFramework</code> API returned. </p>
25032516
* @public
25042517
*/
25052518
framework?: Framework | undefined;
@@ -2931,6 +2944,11 @@ export interface GetAssessmentFrameworkRequest {
29312944
export interface GetAssessmentFrameworkResponse {
29322945
/**
29332946
* <p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>
2947+
* <note>
2948+
* <p>The <code>Controls</code> object returns a partial response when called through
2949+
* Framework APIs. For a complete <code>Controls</code> object, use
2950+
* <code>GetControl</code>.</p>
2951+
* </note>
29342952
* @public
29352953
*/
29362954
framework?: Framework | undefined;
@@ -5303,6 +5321,10 @@ export interface UpdateAssessmentFrameworkRequest {
53035321

53045322
/**
53055323
* <p> The control sets that are associated with the framework. </p>
5324+
* <note>
5325+
* <p>The <code>Controls</code> object returns a partial response when called through Framework
5326+
* APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p>
5327+
* </note>
53065328
* @public
53075329
*/
53085330
controlSets: UpdateAssessmentFrameworkControlSet[] | undefined;
@@ -5313,7 +5335,7 @@ export interface UpdateAssessmentFrameworkRequest {
53135335
*/
53145336
export interface UpdateAssessmentFrameworkResponse {
53155337
/**
5316-
* <p> The name of the framework. </p>
5338+
* <p> The framework object. </p>
53175339
* @public
53185340
*/
53195341
framework?: Framework | undefined;

‎codegen/sdk-codegen/aws-models/auditmanager.json‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3574,7 +3574,7 @@
35743574
"controlSets": {
35753575
"target": "com.amazonaws.auditmanager#CreateAssessmentFrameworkControlSets",
35763576
"traits": {
3577-
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>",
3577+
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>\n <note>\n <p>The <code>Controls</code> object returns a partial response when called through Framework\n APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p>\n </note>",
35783578
"smithy.api#required": {}
35793579
}
35803580
},
@@ -3595,7 +3595,7 @@
35953595
"framework": {
35963596
"target": "com.amazonaws.auditmanager#Framework",
35973597
"traits": {
3598-
"smithy.api#documentation": "<p> The name of the new framework that the <code>CreateAssessmentFramework</code> API\n returned. </p>"
3598+
"smithy.api#documentation": "<p> The new framework object that the <code>CreateAssessmentFramework</code> API returned. </p>"
35993599
}
36003600
}
36013601
},
@@ -5053,13 +5053,17 @@
50535053
"controlSources": {
50545054
"target": "com.amazonaws.auditmanager#ControlSources",
50555055
"traits": {
5056-
"smithy.api#documentation": "<p> The control data sources where Audit Manager collects evidence from.</p>"
5056+
"smithy.api#deprecated": {
5057+
"since": "2025-07-24",
5058+
"message": "Use controlSources from the Control"
5059+
},
5060+
"smithy.api#documentation": "<p> The control data sources where Audit Manager collects evidence from.</p>\n <important>\n <p>This API parameter is no longer supported.</p>\n </important>"
50575061
}
50585062
},
50595063
"controlSets": {
50605064
"target": "com.amazonaws.auditmanager#ControlSets",
50615065
"traits": {
5062-
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>"
5066+
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>\n <note>\n <p>The <code>Controls</code> object returns a partial response when called through\n Framework APIs. For a complete <code>Controls</code> object, use\n <code>GetControl</code>.</p>\n </note>"
50635067
}
50645068
},
50655069
"createdAt": {
@@ -5309,7 +5313,7 @@
53095313
"framework": {
53105314
"target": "com.amazonaws.auditmanager#Framework",
53115315
"traits": {
5312-
"smithy.api#documentation": "<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>"
5316+
"smithy.api#documentation": "<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>\n <note>\n <p>The <code>Controls</code> object returns a partial response when called through\n Framework APIs. For a complete <code>Controls</code> object, use\n <code>GetControl</code>.</p>\n </note>"
53135317
}
53145318
}
53155319
},
@@ -8063,7 +8067,7 @@
80638067
"min": 1,
80648068
"max": 1024
80658069
},
8066-
"smithy.api#pattern": "^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\/]+$"
8070+
"smithy.api#pattern": "^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\=\\+\\@\\:\\s\\,\\?\\/]+$"
80678071
}
80688072
},
80698073
"com.amazonaws.auditmanager#SNSTopic": {
@@ -9076,6 +9080,9 @@
90769080
{
90779081
"target": "com.amazonaws.auditmanager#ResourceNotFoundException"
90789082
},
9083+
{
9084+
"target": "com.amazonaws.auditmanager#ServiceQuotaExceededException"
9085+
},
90799086
{
90809087
"target": "com.amazonaws.auditmanager#ValidationException"
90819088
}
@@ -9161,7 +9168,7 @@
91619168
"controlSets": {
91629169
"target": "com.amazonaws.auditmanager#UpdateAssessmentFrameworkControlSets",
91639170
"traits": {
9164-
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>",
9171+
"smithy.api#documentation": "<p> The control sets that are associated with the framework. </p>\n <note>\n <p>The <code>Controls</code> object returns a partial response when called through Framework\n APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p>\n </note>",
91659172
"smithy.api#required": {}
91669173
}
91679174
}
@@ -9176,7 +9183,7 @@
91769183
"framework": {
91779184
"target": "com.amazonaws.auditmanager#Framework",
91789185
"traits": {
9179-
"smithy.api#documentation": "<p> The name of the framework. </p>"
9186+
"smithy.api#documentation": "<p> The framework object. </p>"
91809187
}
91819188
}
91829189
},

0 commit comments

Comments
 (0)