Skip to content

Add CLI examples for ControTower APIs #9452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

eodeyemi14
Copy link

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.

@ashovlin ashovlin added the documentation This is a problem with documentation. label Apr 22, 2025
@elysahall elysahall self-assigned this Jul 2, 2025
@elysahall elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Jul 2, 2025
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Thank you.

@@ -0,0 +1,16 @@
**To Create Control Tower Landing Zone**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To Create Control Tower Landing Zone**
**To create a Control Tower landing zone**

@@ -0,0 +1,16 @@
**To Create Control Tower Landing Zone**

The following ``create-landing-zone`` example creates AWS Control Tower Landing Zone ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``create-landing-zone`` example creates AWS Control Tower Landing Zone ::
The following ``create-landing-zone`` example creates AWS Control Tower landing zone. ::

Following the casing found in their user guide for "landing zone" .https://docs.aws.amazon.com/controltower/latest/userguide/quick-start.html

"operationIdentifier": "55XXXXXX-e2XX-41XX-a7XX-446XXXXXXXXX"
}

For more information, see `AWS Control Tower Getting Started <https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html>`__ in the *AWS Control Tower User Guide*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more information, see `AWS Control Tower Getting Started <https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html>`__ in the *AWS Control Tower User Guide*.
For more information, see `Getting started with AWS Control Tower
<https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-with-control-tower.html>`__ in the *AWS Control Tower User Guide*.

@@ -0,0 +1,13 @@
**To Decommission Landing Zone**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To Decommission Landing Zone**
**To decommission a landing zone**

{
"operationIdentifier": "47XXXXXX-a6XX-82XX-c9XX-432XXXXXXXXX"
}
For more information, see `Decommission a Landing Zone <https://docs.aws.amazon.com/controltower/latest/userguide/decommission-landing-zone.html>`__ in the *AWS Control Tower User Guide*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more information, see `Decommission a Landing Zone <https://docs.aws.amazon.com/controltower/latest/userguide/decommission-landing-zone.html>`__ in the *AWS Control Tower User Guide*.
For more information, see `Decommission an AWS Control Tower landing zone
<https://docs.aws.amazon.com/controltower/latest/userguide/decommission-landing-zone.html>`__ in the *AWS Control Tower User Guide*.

"operationIdentifier": "214cde95-5c39-46b9-b429-4fad550a7096"
}

The following ``update-enabled-baseline`` example updates an AWS Control Tower enabled baseline if baseline 'IdentityCenterBaseline' is enabled::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-enabled-baseline`` example updates an AWS Control Tower enabled baseline if baseline 'IdentityCenterBaseline' is enabled::
The following ``update-enabled-baseline`` example updates an AWS Control Tower enabled baseline if baseline 'IdentityCenterBaseline' is enabled. ::

"operationIdentifier": "b0f4a7c2-334d-48d9-971e-47fea9db3e8b"
}

For more information, see `AWS Control Tower Baselines <https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html>`__ in the *AWS Control Tower User Guide*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more information, see `AWS Control Tower Baselines <https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html>`__ in the *AWS Control Tower User Guide*.
For more information, see `Types of baselines <https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html>`__ in the *AWS Control Tower User Guide*.

@@ -0,0 +1,15 @@
**To Update A Control Tower Enabled Control**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To Update A Control Tower Enabled Control**
**To update a Control Tower enabled control**

@@ -0,0 +1,15 @@
**To Update A Control Tower Enabled Control**

The following ``update-enabled-control`` example updates an AWS Control Tower enabled control::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-enabled-control`` example updates an AWS Control Tower enabled control::
The following ``update-enabled-control`` example updates an AWS Control Tower enabled control. ::

"operationIdentifier": "b8f0dxxx-08xx-43xx-a2xx-568e9922xxxx"
}

For more information, see `AWS Control Tower Controls <https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html>`__ in the *AWS Control Tower User Guide*.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more information, see `AWS Control Tower Controls <https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html>`__ in the *AWS Control Tower User Guide*.
For more information, see `About controls in AWS Control Tower <https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html>`__ in the *AWS Control Tower User Guide*.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. pr:work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants