|
29 | 29 | {"shape":"ValidationException"}, |
30 | 30 | {"shape":"ThrottlingException"} |
31 | 31 | ], |
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 |
33 | 34 | }, |
34 | 35 | "ListCommonControls":{ |
35 | 36 | "name":"ListCommonControls", |
|
46 | 47 | {"shape":"ValidationException"}, |
47 | 48 | {"shape":"ThrottlingException"} |
48 | 49 | ], |
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 |
50 | 52 | }, |
51 | 53 | "ListControlMappings":{ |
52 | 54 | "name":"ListControlMappings", |
|
63 | 65 | {"shape":"ValidationException"}, |
64 | 66 | {"shape":"ThrottlingException"} |
65 | 67 | ], |
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 |
67 | 70 | }, |
68 | 71 | "ListControls":{ |
69 | 72 | "name":"ListControls", |
|
80 | 83 | {"shape":"ValidationException"}, |
81 | 84 | {"shape":"ThrottlingException"} |
82 | 85 | ], |
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 |
84 | 88 | }, |
85 | 89 | "ListDomains":{ |
86 | 90 | "name":"ListDomains", |
|
97 | 101 | {"shape":"ValidationException"}, |
98 | 102 | {"shape":"ThrottlingException"} |
99 | 103 | ], |
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 |
101 | 106 | }, |
102 | 107 | "ListObjectives":{ |
103 | 108 | "name":"ListObjectives", |
|
114 | 119 | {"shape":"ValidationException"}, |
115 | 120 | {"shape":"ThrottlingException"} |
116 | 121 | ], |
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 |
118 | 124 | } |
119 | 125 | }, |
120 | 126 | "shapes":{ |
|
290 | 296 | }, |
291 | 297 | "MappingType":{ |
292 | 298 | "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>" |
294 | 300 | }, |
295 | 301 | "Mapping":{ |
296 | 302 | "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>" |
298 | 304 | } |
299 | 305 | }, |
300 | 306 | "documentation":"<p>A structure that contains information about a control mapping, including the control ARN, mapping type, and mapping details.</p>" |
|
336 | 342 | "type":"list", |
337 | 343 | "member":{"shape":"ControlParameter"} |
338 | 344 | }, |
| 345 | + "ControlRelationType":{ |
| 346 | + "type":"string", |
| 347 | + "enum":[ |
| 348 | + "COMPLEMENTARY", |
| 349 | + "ALTERNATIVE", |
| 350 | + "MUTUALLY_EXCLUSIVE" |
| 351 | + ] |
| 352 | + }, |
339 | 353 | "ControlScope":{ |
340 | 354 | "type":"string", |
341 | 355 | "enum":[ |
|
823 | 837 | "CommonControl":{ |
824 | 838 | "shape":"CommonControlMappingDetails", |
825 | 839 | "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>" |
826 | 844 | } |
827 | 845 | }, |
828 | 846 | "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 | 850 | "type":"string", |
833 | 851 | "enum":[ |
834 | 852 | "FRAMEWORK", |
835 | | - "COMMON_CONTROL" |
| 853 | + "COMMON_CONTROL", |
| 854 | + "RELATED_CONTROL" |
836 | 855 | ] |
837 | 856 | }, |
838 | 857 | "MappingTypeFilterList":{ |
|
967 | 986 | }, |
968 | 987 | "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>" |
969 | 988 | }, |
| 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 | + }, |
970 | 1004 | "ResourceNotFoundException":{ |
971 | 1005 | "type":"structure", |
972 | 1006 | "members":{ |
|
0 commit comments