Skip to content

Commit 7966224

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
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 f415db8 commit 7966224

16 files changed

+121
-21
lines changed

‎generator/ServiceModels/auditmanager/auditmanager-2017-07-25.api.json

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -856,7 +856,8 @@
856856
{"shape":"ResourceNotFoundException"},
857857
{"shape":"ValidationException"},
858858
{"shape":"AccessDeniedException"},
859-
{"shape":"InternalServerException"}
859+
{"shape":"InternalServerException"},
860+
{"shape":"ServiceQuotaExceededException"}
860861
]
861862
},
862863
"UpdateAssessmentFrameworkShare":{
@@ -2214,7 +2215,12 @@
22142215
"complianceType":{"shape":"ComplianceType"},
22152216
"description":{"shape":"FrameworkDescription"},
22162217
"logo":{"shape":"Filename"},
2217-
"controlSources":{"shape":"ControlSources"},
2218+
"controlSources":{
2219+
"shape":"ControlSources",
2220+
"deprecated":true,
2221+
"deprecatedMessage":"Use controlSources from the Control",
2222+
"deprecatedSince":"2025-07-24"
2223+
},
22182224
"controlSets":{"shape":"ControlSets"},
22192225
"createdAt":{"shape":"Timestamp"},
22202226
"lastUpdatedAt":{"shape":"Timestamp"},
@@ -3230,7 +3236,7 @@
32303236
"type":"string",
32313237
"max":1024,
32323238
"min":1,
3233-
"pattern":"^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\/]+$"
3239+
"pattern":"^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\=\\+\\@\\:\\s\\,\\?\\/]+$"
32343240
},
32353241
"SNSTopic":{
32363242
"type":"string",

‎generator/ServiceModels/auditmanager/auditmanager-2017-07-25.docs.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,7 @@
668668
"ControlSets": {
669669
"base": null,
670670
"refs": {
671-
"Framework$controlSets": "<p> The control sets that are associated with the framework. </p>"
671+
"Framework$controlSets": "<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
672672
}
673673
},
674674
"ControlSetsCount": {
@@ -682,7 +682,7 @@
682682
"refs": {
683683
"Control$controlSources": "<p> The data source types that determine where Audit Manager collects evidence from for the control. </p>",
684684
"ControlMetadata$controlSources": "<p> The data source that determines where Audit Manager collects evidence from for the control. </p>",
685-
"Framework$controlSources": "<p> The control data sources where Audit Manager collects evidence from.</p>"
685+
"Framework$controlSources": "<p> The control data sources where Audit Manager collects evidence from.</p> <important> <p>This API parameter is no longer supported.</p> </important>"
686686
}
687687
},
688688
"ControlState": {
@@ -732,7 +732,7 @@
732732
"CreateAssessmentFrameworkControlSets": {
733733
"base": null,
734734
"refs": {
735-
"CreateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p>"
735+
"CreateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
736736
}
737737
},
738738
"CreateAssessmentFrameworkControls": {
@@ -1065,9 +1065,9 @@
10651065
"Framework": {
10661066
"base": "<p> The file that's used to structure and automate Audit Manager assessments for a given compliance standard. </p>",
10671067
"refs": {
1068-
"CreateAssessmentFrameworkResponse$framework": "<p> The name of the new framework that the <code>CreateAssessmentFramework</code> API returned. </p>",
1069-
"GetAssessmentFrameworkResponse$framework": "<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>",
1070-
"UpdateAssessmentFrameworkResponse$framework": "<p> The name of the framework. </p>"
1068+
"CreateAssessmentFrameworkResponse$framework": "<p> The new framework object that the <code>CreateAssessmentFramework</code> API returned. </p>",
1069+
"GetAssessmentFrameworkResponse$framework": "<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>",
1070+
"UpdateAssessmentFrameworkResponse$framework": "<p> The framework object. </p>"
10711071
}
10721072
},
10731073
"FrameworkDescription": {
@@ -2053,7 +2053,7 @@
20532053
"UpdateAssessmentFrameworkControlSets": {
20542054
"base": null,
20552055
"refs": {
2056-
"UpdateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p>"
2056+
"UpdateAssessmentFrameworkRequest$controlSets": "<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
20572057
}
20582058
},
20592059
"UpdateAssessmentFrameworkRequest": {

‎generator/ServiceModels/auditmanager/auditmanager-2017-07-25.normal.json

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -912,7 +912,8 @@
912912
{"shape":"ResourceNotFoundException"},
913913
{"shape":"ValidationException"},
914914
{"shape":"AccessDeniedException"},
915-
{"shape":"InternalServerException"}
915+
{"shape":"InternalServerException"},
916+
{"shape":"ServiceQuotaExceededException"}
916917
],
917918
"documentation":"<p> Updates a custom framework in Audit Manager. </p>"
918919
},
@@ -2451,7 +2452,7 @@
24512452
},
24522453
"controlSets":{
24532454
"shape":"CreateAssessmentFrameworkControlSets",
2454-
"documentation":"<p> The control sets that are associated with the framework. </p>"
2455+
"documentation":"<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
24552456
},
24562457
"tags":{
24572458
"shape":"TagMap",
@@ -2464,7 +2465,7 @@
24642465
"members":{
24652466
"framework":{
24662467
"shape":"Framework",
2467-
"documentation":"<p> The name of the new framework that the <code>CreateAssessmentFramework</code> API returned. </p>"
2468+
"documentation":"<p> The new framework object that the <code>CreateAssessmentFramework</code> API returned. </p>"
24682469
}
24692470
}
24702471
},
@@ -3184,11 +3185,14 @@
31843185
},
31853186
"controlSources":{
31863187
"shape":"ControlSources",
3187-
"documentation":"<p> The control data sources where Audit Manager collects evidence from.</p>"
3188+
"documentation":"<p> The control data sources where Audit Manager collects evidence from.</p> <important> <p>This API parameter is no longer supported.</p> </important>",
3189+
"deprecated":true,
3190+
"deprecatedMessage":"Use controlSources from the Control",
3191+
"deprecatedSince":"2025-07-24"
31883192
},
31893193
"controlSets":{
31903194
"shape":"ControlSets",
3191-
"documentation":"<p> The control sets that are associated with the framework. </p>"
3195+
"documentation":"<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
31923196
},
31933197
"createdAt":{
31943198
"shape":"Timestamp",
@@ -3294,7 +3298,7 @@
32943298
"members":{
32953299
"framework":{
32963300
"shape":"Framework",
3297-
"documentation":"<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p>"
3301+
"documentation":"<p> The framework that the <code>GetAssessmentFramework</code> API returned. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
32983302
}
32993303
}
33003304
},
@@ -4559,7 +4563,7 @@
45594563
"type":"string",
45604564
"max":1024,
45614565
"min":1,
4562-
"pattern":"^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\/]+$"
4566+
"pattern":"^(S|s)3:\\/\\/[a-zA-Z0-9\\-\\.\\(\\)\\'\\*\\_\\!\\=\\+\\@\\:\\s\\,\\?\\/]+$"
45634567
},
45644568
"SNSTopic":{
45654569
"type":"string",
@@ -5073,7 +5077,7 @@
50735077
},
50745078
"controlSets":{
50755079
"shape":"UpdateAssessmentFrameworkControlSets",
5076-
"documentation":"<p> The control sets that are associated with the framework. </p>"
5080+
"documentation":"<p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>"
50775081
}
50785082
}
50795083
},
@@ -5082,7 +5086,7 @@
50825086
"members":{
50835087
"framework":{
50845088
"shape":"Framework",
5085-
"documentation":"<p> The name of the framework. </p>"
5089+
"documentation":"<p> The framework object. </p>"
50865090
}
50875091
}
50885092
},

‎sdk/src/Services/AuditManager/Generated/Model/CreateAssessmentFrameworkRequest.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ internal bool IsSetComplianceType()
6666
/// <para>
6767
/// The control sets that are associated with the framework.
6868
/// </para>
69+
/// <note>
70+
/// <para>
71+
/// The <c>Controls</c> object returns a partial response when called through Framework
72+
/// APIs. For a complete <c>Controls</c> object, use <c>GetControl</c>.
73+
/// </para>
74+
/// </note>
6975
/// </summary>
7076
[AWSProperty(Required=true, Min=1)]
7177
public List<CreateAssessmentFrameworkControlSet> ControlSets

‎sdk/src/Services/AuditManager/Generated/Model/CreateAssessmentFrameworkResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public partial class CreateAssessmentFrameworkResponse : AmazonWebServiceRespons
3939
/// <summary>
4040
/// Gets and sets the property Framework.
4141
/// <para>
42-
/// The name of the new framework that the <c>CreateAssessmentFramework</c> API returned.
42+
/// The new framework object that the <c>CreateAssessmentFramework</c> API returned.
4343
///
4444
/// </para>
4545
/// </summary>

‎sdk/src/Services/AuditManager/Generated/Model/Framework.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,12 @@ internal bool IsSetComplianceType()
9393
/// <para>
9494
/// The control sets that are associated with the framework.
9595
/// </para>
96+
/// <note>
97+
/// <para>
98+
/// The <c>Controls</c> object returns a partial response when called through Framework
99+
/// APIs. For a complete <c>Controls</c> object, use <c>GetControl</c>.
100+
/// </para>
101+
/// </note>
96102
/// </summary>
97103
[AWSProperty(Sensitive=true, Min=1)]
98104
public List<ControlSet> ControlSets
@@ -112,7 +118,13 @@ internal bool IsSetControlSets()
112118
/// <para>
113119
/// The control data sources where Audit Manager collects evidence from.
114120
/// </para>
121+
/// <important>
122+
/// <para>
123+
/// This API parameter is no longer supported.
124+
/// </para>
125+
/// </important>
115126
/// </summary>
127+
[Obsolete("Use controlSources from the Control")]
116128
[AWSProperty(Min=1, Max=100)]
117129
public string ControlSources
118130
{

‎sdk/src/Services/AuditManager/Generated/Model/GetAssessmentFrameworkResponse.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ public partial class GetAssessmentFrameworkResponse : AmazonWebServiceResponse
4141
/// <para>
4242
/// The framework that the <c>GetAssessmentFramework</c> API returned.
4343
/// </para>
44+
/// <note>
45+
/// <para>
46+
/// The <c>Controls</c> object returns a partial response when called through Framework
47+
/// APIs. For a complete <c>Controls</c> object, use <c>GetControl</c>.
48+
/// </para>
49+
/// </note>
4450
/// </summary>
4551
public Framework Framework
4652
{

‎sdk/src/Services/AuditManager/Generated/Model/Internal/MarshallTransformations/UpdateAssessmentFrameworkResponseUnmarshaller.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ public override AmazonServiceException UnmarshallException(JsonUnmarshallerConte
9393
{
9494
return ResourceNotFoundExceptionUnmarshaller.Instance.Unmarshall(contextCopy, errorResponse);
9595
}
96+
if (errorResponse.Code != null && errorResponse.Code.Equals("ServiceQuotaExceededException"))
97+
{
98+
return ServiceQuotaExceededExceptionUnmarshaller.Instance.Unmarshall(contextCopy, errorResponse);
99+
}
96100
if (errorResponse.Code != null && errorResponse.Code.Equals("ValidationException"))
97101
{
98102
return ValidationExceptionUnmarshaller.Instance.Unmarshall(contextCopy, errorResponse);

‎sdk/src/Services/AuditManager/Generated/Model/UpdateAssessmentFrameworkRequest.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ internal bool IsSetComplianceType()
6666
/// <para>
6767
/// The control sets that are associated with the framework.
6868
/// </para>
69+
/// <note>
70+
/// <para>
71+
/// The <c>Controls</c> object returns a partial response when called through Framework
72+
/// APIs. For a complete <c>Controls</c> object, use <c>GetControl</c>.
73+
/// </para>
74+
/// </note>
6975
/// </summary>
7076
[AWSProperty(Required=true, Min=1)]
7177
public List<UpdateAssessmentFrameworkControlSet> ControlSets

‎sdk/src/Services/AuditManager/Generated/Model/UpdateAssessmentFrameworkResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public partial class UpdateAssessmentFrameworkResponse : AmazonWebServiceRespons
3939
/// <summary>
4040
/// Gets and sets the property Framework.
4141
/// <para>
42-
/// The name of the framework.
42+
/// The framework object.
4343
/// </para>
4444
/// </summary>
4545
public Framework Framework

0 commit comments

Comments
 (0)