Skip to content

update servicecatalog cli example docs#9957

Open
eodeyemi14 wants to merge 1 commit intoaws:developfrom
eodeyemi14:eodeyemi14/servicecatalog-cli-docs
Open

update servicecatalog cli example docs#9957
eodeyemi14 wants to merge 1 commit intoaws:developfrom
eodeyemi14:eodeyemi14/servicecatalog-cli-docs

Conversation

@eodeyemi14
Copy link
Copy Markdown

Issue #, if available:

Description of changes:
This change is to update the AWS Service Catalog CLI example documnetation

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 Jan 5, 2026
@ashovlin ashovlin added needs-review This issue or pull request needs review from a core team member. pr:needs-review This PR needs a review from a Member. and removed needs-review This issue or pull request needs review from a core team member. labels Jan 12, 2026
@kdaily kdaily self-assigned this Jan 20, 2026
Copy link
Copy Markdown
Member

@kdaily kdaily left a comment

Choose a reason for hiding this comment

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

Thanks for the submission, and apologies for the delay in review. There are quite a few things that need attention before we can move forward with this. I've left inline comments and suggestions, and there are some that apply to all of the files:

Each example file is missing a "For more information" link

The style guide
requires every example to end with at least one link to relevant documentation. Please add a link at the end of each file; see the style guide for the syntax.The linked topic should be relevant to the specific command — not every file should use the same link.

Resource IDs are unsanitized or inconsistently sanitized

The [style guide](https://aws.github.io/aws-cli/docs_styleguide.html#sanitizing-sensitive-
information) requires sensitive information to be replaced with placeholders. Some IDs use an xxxxx pattern in the command but show real-looking IDs in the output (
e.g., create-contraint.rst uses port-y3fnkesxxxxx in the command but port-y3fnkeslpoevg in the output). Others like cons-7tr6gei4bfx2g, plan-cuxae3z6glaui,
lpv3-y3fnkeslpoevg, and rec-sbwnhzld3b2ku appear unsanitized throughout.

Please sanitize all IDs consistently across both command and output sections in each file.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The filename is misspelled, missing the s in "constraint". The style guide requires the filename to match the exact command name. Since the command is create-constraint, this file should be renamed to create-constraint.rst. As-is, the example won't be associated with the command and will never be shown to users.

Comment on lines +18 to +19
"ProductId": "prod-cfrfxmra3vnu4",
"PortfolioId": "port-y3fnkeslpoevg"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

These values don't match the inputs. Shouldn't it be:

Suggested change
"ProductId": "prod-cfrfxmra3vnu4",
"PortfolioId": "port-y3fnkeslpoevg"
"ProductId": "prod-cfrfxmraxxxxx",
"PortfolioId": "port-y3fnkesxxxxx"

The following ``delete-provisioned-product-plan`` example deletes a provisioned product plan. ::

aws servicecatalog delete-provisioned-product-plan \
--plan-id "plan-cuxae3z6glaui
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The double quotes aren't matching, which means this command wouldn't run. Here's a fix:

Suggested change
--plan-id "plan-cuxae3z6glaui
--plan-id plan-cuxae3z6glaui

@@ -0,0 +1,38 @@
**To get information about the products to which the caller has access*
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Missing a * at the end, which would cause bold to not be rendered properly.

Suggested change
**To get information about the products to which the caller has access*
**To get information about the products to which the caller has access**

@@ -0,0 +1,38 @@
**To get information about the products to which the caller has access*

The following ``search-products `` example gets all the products the caller has access to. ::
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Extra space after search-products:

Suggested change
The following ``search-products `` example gets all the products the caller has access to. ::
The following ``search-products`` example gets all the products the caller has access to. ::

},
"ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
"Status": "CREATING"
} No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

File should contain a trailing newline.

Suggested change
}
}

aws servicecatalog delete-provisioned-product-plan \
--plan-id "plan-cuxae3z6glaui

This command produces no output. No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

File should contain a trailing newline.

Suggested change
This command produces no output.
This command produces no output.

},
"ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
"Status": "AVAILABLE"
} No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

File should contain a trailing newline.

Suggested change
}
}

"PlanName": "test-plan",
"PlanId": "plan-cuxae3z6glaui",
"ProvisionProductId": "pp-7kh7wbc4xxxxx",
"ProvisionedProductName": "test-params",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Based on the command input -provisioned-product-name test-pp, shouldn't this have the same provisioned product name?

Suggested change
"ProvisionedProductName": "test-params",
"ProvisionedProductName": "test-pp",


{
"ConstraintDetail": {
"ConstraintId": "cons-7tr6gei4bfx2g",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The command uses --id "cons-oqp52evr4bfx2g" but the output shows "ConstraintId": "cons-7tr6gei4bfx2g". Should these be the same ID?

Suggested change
"ConstraintId": "cons-7tr6gei4bfx2g",
"ConstraintId": "cons-oqp52evr4bfx2g",

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:needs-review This PR needs a review from a Member.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants