Skip to content

update servicecatalog cli example docs#9957

Merged
kdaily merged 41 commits into
aws:developfrom
eodeyemi14:eodeyemi14/servicecatalog-cli-docs
Jul 1, 2026
Merged

update servicecatalog cli example docs#9957
kdaily merged 41 commits into
aws:developfrom
eodeyemi14:eodeyemi14/servicecatalog-cli-docs

Conversation

@eodeyemi14

Copy link
Copy Markdown
Contributor

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

@kdaily kdaily left a comment

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.

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 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.

Comment thread awscli/examples/servicecatalog/create-constraint.rst
Comment thread awscli/examples/servicecatalog/create-contraint.rst Outdated
Comment thread awscli/examples/servicecatalog/delete-provisioned-product-plan.rst Outdated
Comment thread awscli/examples/servicecatalog/search-products.rst Outdated
Comment thread awscli/examples/servicecatalog/search-products.rst Outdated
Comment thread awscli/examples/servicecatalog/create-contraint.rst Outdated
Comment thread awscli/examples/servicecatalog/delete-provisioned-product-plan.rst Outdated
Comment thread awscli/examples/servicecatalog/describe-constraint.rst Outdated
Comment thread awscli/examples/servicecatalog/create-provisioned-product-plan.rst Outdated
Comment thread awscli/examples/servicecatalog/describe-constraint.rst Outdated
eodeyemi14 and others added 23 commits May 5, 2026 20:48
Corrected the heading and updated example parameters and output values.
Updated the constraint ID in the delete-constraint example and added a reference to the AWS Service Catalog User Guide.
Updated example IDs in describe-constraint documentation.
Updated example output for list-constraints-for-portfolio command and added reference to AWS documentation.
Updated the constraint ID in the update-constraint example.
Updated the portfolio share token in the example and added a reference to the AWS documentation.
Added a reference link to the AWS Service Catalog User Guide for portfolio sharing.
Added a reference to the AWS Service Catalog User Guide for managing products.
Updated example output with new RecordId, ProvisioningArtifactId, and PathId.
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Removed unnecessary quotes around the plan ID in the example.
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
eodeyemi14 and others added 15 commits May 7, 2026 16:02
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>
Co-authored-by: Kenneth Daily <kdaily@amazon.com>

@kdaily kdaily left a comment

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.

It's really close! Nice job on getting the IDs sanitized and all the other changes applied. Left a few final comments. Once these are resolved we should be good to port it to v2 and release.

Comment thread awscli/examples/servicecatalog/list-launch-paths.rst
Comment thread awscli/examples/servicecatalog/create-provisioned-product-plan.rst
Comment thread awscli/examples/servicecatalog/delete-provisioned-product-plan.rst
Comment thread awscli/examples/servicecatalog/describe-provisioning-parameters.rst
@eodeyemi14 eodeyemi14 requested a review from a team as a code owner June 25, 2026 20:10
Comment thread awscli/examples/servicecatalog/delete-constraint.rst Outdated
@codecov-commenter

codecov-commenter commented Jun 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.60%. Comparing base (c4681b5) to head (536e709).
⚠️ Report is 471 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #9957      +/-   ##
===========================================
+ Coverage    93.39%   93.60%   +0.21%     
===========================================
  Files          210      211       +1     
  Lines        17052    17355     +303     
===========================================
+ Hits         15925    16246     +321     
+ Misses        1127     1109      -18     

☔ View full report in Codecov by Harness.
📢 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.

@kdaily kdaily merged commit 14bceaf into aws:develop Jul 1, 2026
41 checks passed
aws-sdk-python-automation added a commit that referenced this pull request Jul 1, 2026
* release-1.45.39:
  Bumping version to 1.45.39
  Update changelog based on model updates
  Merge pull request #9957 from eodeyemi14/eodeyemi14/servicecatalog-cli-docs
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.

5 participants