|
1424 | 1424 | "smithy.api#required": {} |
1425 | 1425 | } |
1426 | 1426 | }, |
| 1427 | + "remediationTypes": { |
| 1428 | + "target": "com.amazonaws.controltower#RemediationTypes", |
| 1429 | + "traits": { |
| 1430 | + "smithy.api#documentation": "<p>Specifies the types of remediation actions to apply when creating the landing zone, such as automatic drift correction or compliance enforcement.</p>" |
| 1431 | + } |
| 1432 | + }, |
1427 | 1433 | "tags": { |
1428 | 1434 | "target": "com.amazonaws.controltower#TagMap", |
1429 | 1435 | "traits": { |
|
1487 | 1493 | } |
1488 | 1494 | ], |
1489 | 1495 | "traits": { |
1490 | | - "smithy.api#documentation": "<p>Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.</p>", |
| 1496 | + "smithy.api#documentation": "<p>Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.</p> <p>Decommissioning a landing zone is a process with significant consequences, and it cannot be undone. We strongly recommend that you perform this decommissioning process only if you intend to stop using your landing zone.</p>", |
1491 | 1497 | "smithy.api#http": { |
1492 | 1498 | "code": 200, |
1493 | 1499 | "method": "POST", |
|
1643 | 1649 | "controlIdentifier": { |
1644 | 1650 | "target": "com.amazonaws.controltower#ControlIdentifier", |
1645 | 1651 | "traits": { |
1646 | | - "smithy.api#documentation": "<p>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted, with the exception of the <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href=\"https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html\">the overview page</a>.</p>", |
1647 | | - "smithy.api#required": {} |
| 1652 | + "smithy.api#documentation": "<p>The ARN of the control. Only <b>Strongly recommended</b> and <b>Elective</b> controls are permitted, with the exception of the <b>Region deny</b> control. For information on how to find the <code>controlIdentifier</code>, see <a href=\"https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html\">the overview page</a>.</p>" |
1648 | 1653 | } |
1649 | 1654 | }, |
1650 | 1655 | "targetIdentifier": { |
1651 | 1656 | "target": "com.amazonaws.controltower#TargetIdentifier", |
1652 | 1657 | "traits": { |
1653 | | - "smithy.api#documentation": "<p>The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href=\"https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html\">the overview page</a>.</p>", |
1654 | | - "smithy.api#required": {} |
| 1658 | + "smithy.api#documentation": "<p>The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href=\"https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html\">the overview page</a>.</p>" |
| 1659 | + } |
| 1660 | + }, |
| 1661 | + "enabledControlIdentifier": { |
| 1662 | + "target": "com.amazonaws.controltower#Arn", |
| 1663 | + "traits": { |
| 1664 | + "smithy.api#documentation": "<p>The ARN of the enabled control to be disabled, which uniquely identifies the control instance on the target organizational unit.</p>" |
1655 | 1665 | } |
1656 | 1666 | } |
1657 | 1667 | }, |
|
1711 | 1721 | "traits": { |
1712 | 1722 | "smithy.api#documentation": "<p> The drift status of the enabled control.</p> <p>Valid values:</p> <ul> <li> <p> <code>DRIFTED</code>: The <code>enabledControl</code> deployed in this configuration doesn’t match the configuration that Amazon Web Services Control Tower expected. </p> </li> <li> <p> <code>IN_SYNC</code>: The <code>enabledControl</code> deployed in this configuration matches the configuration that Amazon Web Services Control Tower expected.</p> </li> <li> <p> <code>NOT_CHECKING</code>: Amazon Web Services Control Tower does not check drift for this enabled control. Drift is not supported for the control type.</p> </li> <li> <p> <code>UNKNOWN</code>: Amazon Web Services Control Tower is not able to check the drift status for the enabled control. </p> </li> </ul>" |
1713 | 1723 | } |
| 1724 | + }, |
| 1725 | + "types": { |
| 1726 | + "target": "com.amazonaws.controltower#EnabledControlDriftTypes", |
| 1727 | + "traits": { |
| 1728 | + "smithy.api#documentation": "<p>An object that categorizes the different types of drift detected for the enabled control.</p>" |
| 1729 | + } |
1714 | 1730 | } |
1715 | 1731 | }, |
1716 | 1732 | "traits": { |
|
2315 | 2331 | "smithy.api#documentation": "<p>The ARN of the organizational unit. For information on how to find the <code>targetIdentifier</code>, see <a href=\"https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html\">the overview page</a>.</p>" |
2316 | 2332 | } |
2317 | 2333 | }, |
2318 | | - "targetRegions": { |
2319 | | - "target": "com.amazonaws.controltower#TargetRegions", |
2320 | | - "traits": { |
2321 | | - "smithy.api#documentation": "<p>Target Amazon Web Services Regions for the enabled control.</p>" |
2322 | | - } |
2323 | | - }, |
2324 | 2334 | "statusSummary": { |
2325 | 2335 | "target": "com.amazonaws.controltower#EnablementStatusSummary", |
2326 | 2336 | "traits": { |
|
2333 | 2343 | "smithy.api#documentation": "<p>The drift status of the enabled control.</p>" |
2334 | 2344 | } |
2335 | 2345 | }, |
| 2346 | + "parentIdentifier": { |
| 2347 | + "target": "com.amazonaws.controltower#ParentIdentifier", |
| 2348 | + "traits": { |
| 2349 | + "smithy.api#documentation": "<p>The ARN of the parent enabled control from which this control inherits its configuration, if applicable.</p>" |
| 2350 | + } |
| 2351 | + }, |
| 2352 | + "targetRegions": { |
| 2353 | + "target": "com.amazonaws.controltower#TargetRegions", |
| 2354 | + "traits": { |
| 2355 | + "smithy.api#documentation": "<p>Target Amazon Web Services Regions for the enabled control.</p>" |
| 2356 | + } |
| 2357 | + }, |
2336 | 2358 | "parameters": { |
2337 | 2359 | "target": "com.amazonaws.controltower#EnabledControlParameterSummaries", |
2338 | 2360 | "traits": { |
|
2344 | 2366 | "smithy.api#documentation": "<p>Information about the enabled control.</p>" |
2345 | 2367 | } |
2346 | 2368 | }, |
| 2369 | + "com.amazonaws.controltower#EnabledControlDriftTypes": { |
| 2370 | + "type": "structure", |
| 2371 | + "members": { |
| 2372 | + "inheritance": { |
| 2373 | + "target": "com.amazonaws.controltower#EnabledControlInheritanceDrift", |
| 2374 | + "traits": { |
| 2375 | + "smithy.api#documentation": "<p>Indicates drift related to inheritance configuration between parent and child controls.</p>" |
| 2376 | + } |
| 2377 | + }, |
| 2378 | + "resource": { |
| 2379 | + "target": "com.amazonaws.controltower#EnabledControlResourceDrift", |
| 2380 | + "traits": { |
| 2381 | + "smithy.api#documentation": "<p>Indicates drift related to the underlying Amazon Web Services resources managed by the control.</p>" |
| 2382 | + } |
| 2383 | + } |
| 2384 | + }, |
| 2385 | + "traits": { |
| 2386 | + "smithy.api#documentation": "<p>Defines the various categories of drift that can occur for an enabled control resource.</p>" |
| 2387 | + } |
| 2388 | + }, |
2347 | 2389 | "com.amazonaws.controltower#EnabledControlFilter": { |
2348 | 2390 | "type": "structure", |
2349 | 2391 | "members": { |
|
2364 | 2406 | "traits": { |
2365 | 2407 | "smithy.api#documentation": "<p>A list of <code>DriftStatus</code> items.</p>" |
2366 | 2408 | } |
| 2409 | + }, |
| 2410 | + "parentIdentifiers": { |
| 2411 | + "target": "com.amazonaws.controltower#ParentIdentifiers", |
| 2412 | + "traits": { |
| 2413 | + "smithy.api#documentation": "<p>Filters enabled controls by their parent control identifiers, allowing you to find child controls of specific parent controls.</p>" |
| 2414 | + } |
| 2415 | + }, |
| 2416 | + "inheritanceDriftStatuses": { |
| 2417 | + "target": "com.amazonaws.controltower#DriftStatuses", |
| 2418 | + "traits": { |
| 2419 | + "smithy.api#documentation": "<p>Filters enabled controls by their inheritance drift status, allowing you to find controls with specific inheritance-related drift conditions.</p>" |
| 2420 | + } |
| 2421 | + }, |
| 2422 | + "resourceDriftStatuses": { |
| 2423 | + "target": "com.amazonaws.controltower#DriftStatuses", |
| 2424 | + "traits": { |
| 2425 | + "smithy.api#documentation": "<p>Filters enabled controls by their resource drift status, allowing you to find controls with specific resource-related drift conditions.</p>" |
| 2426 | + } |
2367 | 2427 | } |
2368 | 2428 | }, |
2369 | 2429 | "traits": { |
|
2382 | 2442 | } |
2383 | 2443 | } |
2384 | 2444 | }, |
| 2445 | + "com.amazonaws.controltower#EnabledControlInheritanceDrift": { |
| 2446 | + "type": "structure", |
| 2447 | + "members": { |
| 2448 | + "status": { |
| 2449 | + "target": "com.amazonaws.controltower#DriftStatus", |
| 2450 | + "traits": { |
| 2451 | + "smithy.api#documentation": "<p>The status of inheritance drift for the enabled control, indicating whether inheritance configuration matches expectations.</p>" |
| 2452 | + } |
| 2453 | + } |
| 2454 | + }, |
| 2455 | + "traits": { |
| 2456 | + "smithy.api#documentation": "<p>Represents drift information related to control inheritance between organizational units.</p>" |
| 2457 | + } |
| 2458 | + }, |
2385 | 2459 | "com.amazonaws.controltower#EnabledControlParameter": { |
2386 | 2460 | "type": "structure", |
2387 | 2461 | "members": { |
|
2463 | 2537 | } |
2464 | 2538 | ] |
2465 | 2539 | }, |
2466 | | - "com.amazonaws.controltower#EnabledControlSummary": { |
| 2540 | + "com.amazonaws.controltower#EnabledControlResourceDrift": { |
2467 | 2541 | "type": "structure", |
2468 | 2542 | "members": { |
2469 | | - "controlIdentifier": { |
2470 | | - "target": "com.amazonaws.controltower#ControlIdentifier", |
| 2543 | + "status": { |
| 2544 | + "target": "com.amazonaws.controltower#DriftStatus", |
2471 | 2545 | "traits": { |
2472 | | - "smithy.api#documentation": "<p>The <code>controlIdentifier</code> of the enabled control.</p>" |
| 2546 | + "smithy.api#documentation": "<p>The status of resource drift for the enabled control, indicating whether the underlying resources match the expected configuration.</p>" |
2473 | 2547 | } |
2474 | | - }, |
| 2548 | + } |
| 2549 | + }, |
| 2550 | + "traits": { |
| 2551 | + "smithy.api#documentation": "<p>Represents drift information related to the underlying Amazon Web Services resources managed by the control.</p>" |
| 2552 | + } |
| 2553 | + }, |
| 2554 | + "com.amazonaws.controltower#EnabledControlSummary": { |
| 2555 | + "type": "structure", |
| 2556 | + "members": { |
2475 | 2557 | "arn": { |
2476 | 2558 | "target": "com.amazonaws.controltower#Arn", |
2477 | 2559 | "traits": { |
2478 | 2560 | "smithy.api#documentation": "<p>The ARN of the enabled control.</p>" |
2479 | 2561 | } |
2480 | 2562 | }, |
| 2563 | + "controlIdentifier": { |
| 2564 | + "target": "com.amazonaws.controltower#ControlIdentifier", |
| 2565 | + "traits": { |
| 2566 | + "smithy.api#documentation": "<p>The <code>controlIdentifier</code> of the enabled control.</p>" |
| 2567 | + } |
| 2568 | + }, |
2481 | 2569 | "targetIdentifier": { |
2482 | 2570 | "target": "com.amazonaws.controltower#TargetIdentifier", |
2483 | 2571 | "traits": { |
|
2495 | 2583 | "traits": { |
2496 | 2584 | "smithy.api#documentation": "<p>The drift status of the enabled control.</p>" |
2497 | 2585 | } |
| 2586 | + }, |
| 2587 | + "parentIdentifier": { |
| 2588 | + "target": "com.amazonaws.controltower#ParentIdentifier", |
| 2589 | + "traits": { |
| 2590 | + "smithy.api#documentation": "<p>The ARN of the parent enabled control from which this control inherits its configuration, if applicable.</p>" |
| 2591 | + } |
2498 | 2592 | } |
2499 | 2593 | }, |
2500 | 2594 | "traits": { |
|
3063 | 3157 | "smithy.api#required": {} |
3064 | 3158 | } |
3065 | 3159 | }, |
| 3160 | + "remediationTypes": { |
| 3161 | + "target": "com.amazonaws.controltower#RemediationTypes", |
| 3162 | + "traits": { |
| 3163 | + "smithy.api#documentation": "<p>The types of remediation actions configured for the landing zone, such as automatic drift correction or compliance enforcement.</p>" |
| 3164 | + } |
| 3165 | + }, |
3066 | 3166 | "arn": { |
3067 | 3167 | "target": "com.amazonaws.controltower#Arn", |
3068 | 3168 | "traits": { |
|
3758 | 3858 | "traits": { |
3759 | 3859 | "smithy.api#documentation": "<p>An input filter for the <code>ListEnabledControls</code> API that lets you select the types of control operations to view.</p>" |
3760 | 3860 | } |
| 3861 | + }, |
| 3862 | + "includeChildren": { |
| 3863 | + "target": "smithy.api#Boolean", |
| 3864 | + "traits": { |
| 3865 | + "smithy.api#default": false, |
| 3866 | + "smithy.api#documentation": "<p>A boolean value that determines whether to include enabled controls from child organizational units in the response.</p>" |
| 3867 | + } |
3761 | 3868 | } |
3762 | 3869 | }, |
3763 | 3870 | "traits": { |
|
4053 | 4160 | "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" |
4054 | 4161 | } |
4055 | 4162 | }, |
| 4163 | + "com.amazonaws.controltower#ParentIdentifier": { |
| 4164 | + "type": "string", |
| 4165 | + "traits": { |
| 4166 | + "smithy.api#length": { |
| 4167 | + "min": 20, |
| 4168 | + "max": 2048 |
| 4169 | + }, |
| 4170 | + "smithy.api#pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$" |
| 4171 | + } |
| 4172 | + }, |
| 4173 | + "com.amazonaws.controltower#ParentIdentifiers": { |
| 4174 | + "type": "list", |
| 4175 | + "member": { |
| 4176 | + "target": "com.amazonaws.controltower#ParentIdentifier" |
| 4177 | + }, |
| 4178 | + "traits": { |
| 4179 | + "smithy.api#length": { |
| 4180 | + "min": 1, |
| 4181 | + "max": 1 |
| 4182 | + } |
| 4183 | + } |
| 4184 | + }, |
4056 | 4185 | "com.amazonaws.controltower#Region": { |
4057 | 4186 | "type": "structure", |
4058 | 4187 | "members": { |
|
4076 | 4205 | } |
4077 | 4206 | } |
4078 | 4207 | }, |
| 4208 | + "com.amazonaws.controltower#RemediationType": { |
| 4209 | + "type": "enum", |
| 4210 | + "members": { |
| 4211 | + "INHERITANCE_DRIFT": { |
| 4212 | + "target": "smithy.api#Unit", |
| 4213 | + "traits": { |
| 4214 | + "smithy.api#enumValue": "INHERITANCE_DRIFT" |
| 4215 | + } |
| 4216 | + } |
| 4217 | + } |
| 4218 | + }, |
| 4219 | + "com.amazonaws.controltower#RemediationTypes": { |
| 4220 | + "type": "list", |
| 4221 | + "member": { |
| 4222 | + "target": "com.amazonaws.controltower#RemediationType" |
| 4223 | + }, |
| 4224 | + "traits": { |
| 4225 | + "smithy.api#length": { |
| 4226 | + "min": 1, |
| 4227 | + "max": 1 |
| 4228 | + } |
| 4229 | + } |
| 4230 | + }, |
4079 | 4231 | "com.amazonaws.controltower#ResetEnabledBaseline": { |
4080 | 4232 | "type": "operation", |
4081 | 4233 | "input": { |
|
4178 | 4330 | } |
4179 | 4331 | ], |
4180 | 4332 | "traits": { |
4181 | | - "smithy.api#documentation": "<p>Resets an enabled control.</p>", |
| 4333 | + "smithy.api#documentation": "<p>Resets an enabled control. Does not work for controls implemented with SCPs.</p>", |
4182 | 4334 | "smithy.api#http": { |
4183 | 4335 | "code": 200, |
4184 | 4336 | "method": "POST", |
|
4310 | 4462 | } |
4311 | 4463 | }, |
4312 | 4464 | "traits": { |
4313 | | - "smithy.api#documentation": "<p>The request would cause a service quota to be exceeded. The limit is 100 concurrent operations.</p>", |
| 4465 | + "smithy.api#documentation": "<p>The request would cause a service quota to be exceeded. See <a href=\"https://docs.aws.amazon.com/controltower/latest/userguide/request-an-increase.html\">Service quotas</a>.</p>", |
4314 | 4466 | "smithy.api#error": "client", |
4315 | 4467 | "smithy.api#httpError": 402 |
4316 | 4468 | } |
|
4782 | 4934 | "smithy.api#required": {} |
4783 | 4935 | } |
4784 | 4936 | }, |
| 4937 | + "remediationTypes": { |
| 4938 | + "target": "com.amazonaws.controltower#RemediationTypes", |
| 4939 | + "traits": { |
| 4940 | + "smithy.api#documentation": "<p>Specifies the types of remediation actions to apply when updating the landing zone configuration.</p>" |
| 4941 | + } |
| 4942 | + }, |
4785 | 4943 | "landingZoneIdentifier": { |
4786 | 4944 | "target": "smithy.api#String", |
4787 | 4945 | "traits": { |
|
0 commit comments