Add CLI examples for ControTower APIs by eodeyemi14 · Pull Request #9452 · aws/aws-cli

eodeyemi14 · 2025-04-18T20:43:47Z

Issue #, if available:
N/A
Description of changes:
This PR adds example CLI inputs and outputs of all AWS Control Tower APIs

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

elysahall

Hello @eodeyemi14,
Thank you for your contribution! Please review the requested format changes, rebase, commit, and push your updates.

Thank you.

eodeyemi14 · 2025-11-09T21:04:39Z

Hello @eodeyemi14, Thank you for your contribution! Please review the requested format changes, rebase, commit, and push your updates.

Thank you.

H @elysahall This has been updated. Please review.

AndrewAsseily · 2026-05-05T15:14:44Z

Hey @eodeyemi14, looks good thanks! In enable-baseline.rst, let's use dummy values (like 123456789012 and masked org IDs) to stay consistent with the rest of the examples. Also, could you add a trailing newline to each .rst file? Thanks!

Co-authored-by: Elysa <60367675+elysahall@users.noreply.github.com>

Added a reference to the AWS Control Tower User Guide.

codecov-commenter · 2026-05-07T01:57:33Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.43%. Comparing base (68039fa) to head (0d8f142).
⚠️ Report is 829 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #9452      +/-   ##
===========================================
+ Coverage    93.40%   93.43%   +0.03%     
===========================================
  Files          211      211              
  Lines        17012    17283     +271     
===========================================
+ Hits         15890    16149     +259     
- Misses        1122     1134      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

AndrewAsseily · 2026-05-07T19:25:17Z

+                "startTime": "2024-02-19T19:21:09+00:00",
+                "operationType": "ENABLE_CONTROL",
+                "status": "IN_PROGRESS",
+                "statusMessage": "Operation is in progress."


Missing comma after "statusMessage": "Operation is in progress.". This makes the JSON invalid.

AndrewAsseily · 2026-05-07T19:26:43Z

+                        "loggingBucket": {
+                            "retentionDays": 365
+                        },
+                        "kmsKeyArn": "<arn_of_kms_key",


Stray < with no closing >. Should probably be a placeholder ARN like "arn:aws:kms:us-east-1:123456789012:key/example-key-id"

AndrewAsseily · 2026-05-07T19:27:46Z

+The following ``update-enabled-control`` example updates an AWS Control Tower enabled control. ::
+
+    aws controltower update-enabled-control \
+        --enabled-control-identifier arn:aws:controltower:us-east-1:493301538276:enabledcontrol/JSJN8UL0G2MWGRTZ \


This uses 493301538276. Can we use a value like all the other examples to keep it consistent (123456789012 as the placeholder account ID)

AndrewAsseily · 2026-05-07T19:28:31Z

@@ -0,0 +1,19 @@
+**To get a Control Tower landing zone operation**
+
+The following ``get-landing-zone-operation`` example get details of an AWS Control Tower landing zone operation. ::


A few of the descriptions say "get details" where it should be "gets details"

Co-authored-by: Elysa <60367675+elysahall@users.noreply.github.com>

Remove extra newline before the output note.

Removed redundant information and example header.

Removed redundant information about baseline types.

AndrewAsseily

Thanks!

* release-1.45.7: Bumping version to 1.45.7 Update changelog based on model updates Add CLI examples for ControTower APIs (#9452) Add Express Configuration example to create-db-cluster CLI docs (#10300) Adding path and state parameters to outputs where appropriate (#10288)

ashovlin added the documentation This is a problem with documentation. label Apr 22, 2025

elysahall self-assigned this Jul 2, 2025

elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Jul 2, 2025

elysahall suggested changes Jul 3, 2025

View reviewed changes

eodeyemi14 added 2 commits November 9, 2025 14:57

Add CLI examples for ControTower APIs

9b86dab

fix control tower examples

190c64d

eodeyemi14 force-pushed the eodeyemi/controltower-cli-docs branch from 113f658 to 190c64d Compare November 9, 2025 20:58

github-actions Bot mentioned this pull request May 5, 2026

[V2] Add CLI examples for ControTower APIs #10275

Closed

2 tasks

eodeyemi14 and others added 20 commits May 5, 2026 20:09

fix enable-baseline

4ce7924

Co-authored-by: Elysa <60367675+elysahall@users.noreply.github.com>

Update target identifier in enable-baseline example

4b80c02

Fix formatting in create-landing-zone.rst

382cb5d

Fix formatting issue in delete-landing-zone.rst

d04081f

Fix formatting of disable-control.rst

d18844f

Fix formatting in enable-control.rst

13ac031

Fix newline at end of get-baseline-operation.rst

e1fac72

Fix missing newline at end of get-baseline.rst

4f270cd

Fix missing newline at end of get-control-operation.rst

8b35da8

Fix newline at end of get-enabled-baseline.rst

3a4a4d3

Fix formatting in get-enabled-control.rst

93ef017

Fix formatting in get-landing-zone-operation.rst

dbe942a

Fix newline at end of get-landing-zone.rst

83306b9

Fix formatting in list-baselines.rst

f667e46

Fix formatting of the information link in documentation

ed80ba2

Fix formatting

0fd6541

Fix formatting in list-enabled-controls.rst

a2ae5a8

Fix formatting of landing zone operations documentation

c9e16a3

Fix formatting in list-landing-zones.rst

374fda7

Fix formatting of list-tags-for-resource.rst

8d86d57

eodeyemi14 added 9 commits May 5, 2026 20:28

Fix newline at end of reset-landing-zone.rst

39dff0f

Fix formatting in tag-resource.rst

85d542b

Fix formatting of resource untagging documentation

3275908

Fix formatting issue in update-enabled-baseline.rst

e135faf

Fix missing newline at end of update-enabled-control.rst

75c65f0

Fix formatting in update-landing-zone.rst

a2feda7

Fix formatting in delete-landing-zone.rst

11cbcf5

Fix formatting in update-landing-zone.rst

0b24cd1

Update get-landing-zone.rst with user guide link

fcd51bc

Added a reference to the AWS Control Tower User Guide.

AndrewAsseily requested changes May 7, 2026

View reviewed changes

eodeyemi14 and others added 15 commits May 12, 2026 08:52

Update example ARN in update-enabled-control.rst

fa99a97

Apply suggestion from @elysahall

ca7f05c

Co-authored-by: Elysa <60367675+elysahall@users.noreply.github.com>

Fix formatting by removing extra newline

9cd9ed1

Remove extra newline before the output note.

Fix typo in list-enabled-controls documentation

c974748

Fix statusMessage formatting in list-control-operations.rst

466c8af

Update centralized logging account ID and KMS key ARN

c7e8fa5

Fix grammar in get-landing-zone-operation example

9264ef8

Update get-landing-zone-operation.rst

9c56274

Fix grammatical error in get-enabled-control example

b9217e1

Update get-enabled-baseline.rst

8d191de

Update get-control-operation.rst

143743f

Fix grammatical error in get-baseline-operation example

32810f1

Clean up enable-baseline.rst content

c4a30fd

Removed redundant information and example header.

Simplify update-enabled-baseline example

98696e8

Removed redundant information about baseline types.

Fix grammatical error in documentation example

0d8f142

AndrewAsseily mentioned this pull request May 12, 2026

Add CLI examples for ControlTower APIs (v2 port of #9452) #10302

Merged

AndrewAsseily approved these changes May 12, 2026

View reviewed changes

AndrewAsseily merged commit d29df49 into aws:develop May 12, 2026
41 checks passed

		@@ -0,0 +1,19 @@
		To get a Control Tower landing zone operation

		The following ``get-landing-zone-operation`` example get details of an AWS Control Tower landing zone operation. ::

Conversation

eodeyemi14 commented Apr 18, 2025

Uh oh!

elysahall left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eodeyemi14 commented Nov 9, 2025

Uh oh!

AndrewAsseily commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AndrewAsseily May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AndrewAsseily May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

AndrewAsseily May 7, 2026

Choose a reason for hiding this comment

Uh oh!

AndrewAsseily May 7, 2026

Choose a reason for hiding this comment

Uh oh!

AndrewAsseily left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

AndrewAsseily commented May 5, 2026 •

edited

Loading

codecov-commenter commented May 7, 2026 •

edited

Loading