Skip to content

Commit e947cf4

Browse files
author
AWS
committed
AWS Control Catalog Update: Added support for related control mappings with new RELATED_CONTROL mapping type in ListControlMappings API.
1 parent ad06119 commit e947cf4

File tree

2 files changed

+49
-9
lines changed

2 files changed

+49
-9
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Control Catalog",
4+
"contributor": "",
5+
"description": "Added support for related control mappings with new RELATED_CONTROL mapping type in ListControlMappings API."
6+
}

services/controlcatalog/src/main/resources/codegen-resources/service-2.json

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
{"shape":"ValidationException"},
3030
{"shape":"ThrottlingException"}
3131
],
32-
"documentation":"<p>Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the <i>ControlArn</i> parameter, in ARN form. <code>GetControl</code> accepts <i>controltower</i> or <i>controlcatalog</i> control ARNs as input. Returns a <i>controlcatalog</i> ARN format.</p> <p>In the API response, controls that have the value <code>GLOBAL</code> in the <code>Scope</code> field do not show the <code>DeployableRegions</code> field, because it does not apply. Controls that have the value <code>REGIONAL</code> in the <code>Scope</code> field return a value for the <code>DeployableRegions</code> field, as shown in the example.</p>"
32+
"documentation":"<p>Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the <i>ControlArn</i> parameter, in ARN form. <code>GetControl</code> accepts <i>controltower</i> or <i>controlcatalog</i> control ARNs as input. Returns a <i>controlcatalog</i> ARN format.</p> <p>In the API response, controls that have the value <code>GLOBAL</code> in the <code>Scope</code> field do not show the <code>DeployableRegions</code> field, because it does not apply. Controls that have the value <code>REGIONAL</code> in the <code>Scope</code> field return a value for the <code>DeployableRegions</code> field, as shown in the example.</p>",
33+
"readonly":true
3334
},
3435
"ListCommonControls":{
3536
"name":"ListCommonControls",
@@ -46,7 +47,8 @@
4647
{"shape":"ValidationException"},
4748
{"shape":"ThrottlingException"}
4849
],
49-
"documentation":"<p>Returns a paginated list of common controls from the Amazon Web Services Control Catalog.</p> <p>You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls. </p>"
50+
"documentation":"<p>Returns a paginated list of common controls from the Amazon Web Services Control Catalog.</p> <p>You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls. </p>",
51+
"readonly":true
5052
},
5153
"ListControlMappings":{
5254
"name":"ListControlMappings",
@@ -63,7 +65,8 @@
6365
{"shape":"ValidationException"},
6466
{"shape":"ThrottlingException"}
6567
],
66-
"documentation":"<p>Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.</p>"
68+
"documentation":"<p>Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.</p>",
69+
"readonly":true
6770
},
6871
"ListControls":{
6972
"name":"ListControls",
@@ -80,7 +83,8 @@
8083
{"shape":"ValidationException"},
8184
{"shape":"ThrottlingException"}
8285
],
83-
"documentation":"<p>Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type <i>controlSummary</i>. The ARN is returned in the global <i>controlcatalog</i> format, as shown in the examples.</p>"
86+
"documentation":"<p>Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type <i>controlSummary</i>. The ARN is returned in the global <i>controlcatalog</i> format, as shown in the examples.</p>",
87+
"readonly":true
8488
},
8589
"ListDomains":{
8690
"name":"ListDomains",
@@ -97,7 +101,8 @@
97101
{"shape":"ValidationException"},
98102
{"shape":"ThrottlingException"}
99103
],
100-
"documentation":"<p>Returns a paginated list of domains from the Control Catalog.</p>"
104+
"documentation":"<p>Returns a paginated list of domains from the Control Catalog.</p>",
105+
"readonly":true
101106
},
102107
"ListObjectives":{
103108
"name":"ListObjectives",
@@ -114,7 +119,8 @@
114119
{"shape":"ValidationException"},
115120
{"shape":"ThrottlingException"}
116121
],
117-
"documentation":"<p>Returns a paginated list of objectives from the Control Catalog.</p> <p>You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives. </p>"
122+
"documentation":"<p>Returns a paginated list of objectives from the Control Catalog.</p> <p>You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives. </p>",
123+
"readonly":true
118124
}
119125
},
120126
"shapes":{
@@ -290,11 +296,11 @@
290296
},
291297
"MappingType":{
292298
"shape":"MappingType",
293-
"documentation":"<p>The type of mapping relationship between the control and other entities. Indicates whether the mapping is to a framework or common control.</p>"
299+
"documentation":"<p>The type of mapping relationship between the control and other entities.</p>"
294300
},
295301
"Mapping":{
296302
"shape":"Mapping",
297-
"documentation":"<p>The details of the mapping relationship, containing either framework or common control information.</p>"
303+
"documentation":"<p>The details of the mapping relationship, for example, containing framework, common control, or related control information.</p>"
298304
}
299305
},
300306
"documentation":"<p>A structure that contains information about a control mapping, including the control ARN, mapping type, and mapping details.</p>"
@@ -336,6 +342,14 @@
336342
"type":"list",
337343
"member":{"shape":"ControlParameter"}
338344
},
345+
"ControlRelationType":{
346+
"type":"string",
347+
"enum":[
348+
"COMPLEMENTARY",
349+
"ALTERNATIVE",
350+
"MUTUALLY_EXCLUSIVE"
351+
]
352+
},
339353
"ControlScope":{
340354
"type":"string",
341355
"enum":[
@@ -823,6 +837,10 @@
823837
"CommonControl":{
824838
"shape":"CommonControlMappingDetails",
825839
"documentation":"<p>The common control mapping details when the mapping type relates to a common control.</p>"
840+
},
841+
"RelatedControl":{
842+
"shape":"RelatedControlMappingDetails",
843+
"documentation":"<p>Returns information about controls that are related to the specified control.</p>"
826844
}
827845
},
828846
"documentation":"<p>A structure that contains the details of a mapping relationship, which can be either to a framework or to a common control.</p>",
@@ -832,7 +850,8 @@
832850
"type":"string",
833851
"enum":[
834852
"FRAMEWORK",
835-
"COMMON_CONTROL"
853+
"COMMON_CONTROL",
854+
"RELATED_CONTROL"
836855
]
837856
},
838857
"MappingTypeFilterList":{
@@ -967,6 +986,21 @@
967986
},
968987
"documentation":"<p>Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control is available for deployment. For more information about scope, see <a href=\"https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html\">Global services</a>.</p> <p>If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the <code>RegionConfiguration</code> API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions <code>A</code>,<code>B</code>,and <code>C</code> while the control is available in Regions <code>A</code>, <code>B</code>, C<code>,</code> and <code>D</code>, you'd see a response with <code>DeployableRegions</code> of <code>A</code>, <code>B</code>, <code>C</code>, and <code>D</code> for a control with <code>REGIONAL</code> scope, even though you may not intend to deploy the control in Region <code>D</code>, because you do not govern it through your landing zone.</p>"
969988
},
989+
"RelatedControlMappingDetails":{
990+
"type":"structure",
991+
"required":["RelationType"],
992+
"members":{
993+
"ControlArn":{
994+
"shape":"ControlArn",
995+
"documentation":"<p>The unique identifier of a control.</p>"
996+
},
997+
"RelationType":{
998+
"shape":"ControlRelationType",
999+
"documentation":"<p>Returns an enumerated value that represents the relationship between two or more controls.</p>"
1000+
}
1001+
},
1002+
"documentation":"<p>A structure that describes a control's relationship status with other controls.</p>"
1003+
},
9701004
"ResourceNotFoundException":{
9711005
"type":"structure",
9721006
"members":{

0 commit comments

Comments
 (0)