From 49a622bc5cd87d23e1e15bf9c4480ec5225f2ce8 Mon Sep 17 00:00:00 2001 From: eodeyemi14 Date: Wed, 31 Dec 2025 17:15:57 -0600 Subject: [PATCH 01/22] update servicecatalog cli docs --- .../servicecatalog/create-contraint.rst | 23 +++++++ .../create-provisioned-product-plan.rst | 20 ++++++ .../servicecatalog/delete-constraint.rst | 8 +++ .../delete-provisioned-product-plan.rst | 8 +++ .../servicecatalog/describe-constraint.rst | 20 ++++++ .../describe-portfolio-share-status.rst | 21 +++++++ .../describe-portfolio-shares.rst | 28 +++++++++ .../servicecatalog/describe-product.rst | 52 +++++++++++++++ .../describe-provisioned-product-plan.rst | 25 ++++++++ .../describe-provisioning-parameters.rst | 63 +++++++++++++++++++ .../list-constraints-for-portfolio.rst | 52 +++++++++++++++ .../servicecatalog/list-launch-paths.rst | 23 +++++++ .../servicecatalog/search-products.rst | 38 +++++++++++ .../terminate-provisioned-product.rst | 28 +++++++++ .../servicecatalog/update-constraint.rst | 22 +++++++ 15 files changed, 431 insertions(+) create mode 100644 awscli/examples/servicecatalog/create-contraint.rst create mode 100644 awscli/examples/servicecatalog/create-provisioned-product-plan.rst create mode 100644 awscli/examples/servicecatalog/delete-constraint.rst create mode 100644 awscli/examples/servicecatalog/delete-provisioned-product-plan.rst create mode 100644 awscli/examples/servicecatalog/describe-constraint.rst create mode 100644 awscli/examples/servicecatalog/describe-portfolio-share-status.rst create mode 100644 awscli/examples/servicecatalog/describe-portfolio-shares.rst create mode 100644 awscli/examples/servicecatalog/describe-product.rst create mode 100644 awscli/examples/servicecatalog/describe-provisioned-product-plan.rst create mode 100644 awscli/examples/servicecatalog/describe-provisioning-parameters.rst create mode 100644 awscli/examples/servicecatalog/list-constraints-for-portfolio.rst create mode 100644 awscli/examples/servicecatalog/list-launch-paths.rst create mode 100644 awscli/examples/servicecatalog/search-products.rst create mode 100644 awscli/examples/servicecatalog/terminate-provisioned-product.rst create mode 100644 awscli/examples/servicecatalog/update-constraint.rst diff --git a/awscli/examples/servicecatalog/create-contraint.rst b/awscli/examples/servicecatalog/create-contraint.rst new file mode 100644 index 000000000000..169d565f09ad --- /dev/null +++ b/awscli/examples/servicecatalog/create-contraint.rst @@ -0,0 +1,23 @@ +**To create a constraint** + +The following ``create-constraint`` example creates a constraint. :: + + aws servicecatalog create-constraint \ + --portfolio-id port-y3fnkesxxxxx \ + --product-id prod-cfrfxmraxxxxx \ + --type LAUNCH \ + --parameters '{"RoleArn" : "arn:aws:iam::123456789012:role/NewLaunchRole"}' + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-7tr6gei4bfx2g", + "Type": "LAUNCH", + "Owner": "123456789012", + "ProductId": "prod-cfrfxmra3vnu4", + "PortfolioId": "port-y3fnkeslpoevg" + }, + "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", + "Status": "CREATING" + } \ No newline at end of file diff --git a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst new file mode 100644 index 000000000000..c82da146fd62 --- /dev/null +++ b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst @@ -0,0 +1,20 @@ +**To create a plan** + +The following ``create-provisioned-product-plan`` example creates a plan. :: + + aws servicecatalog create-provisioned-product-plan \ + --plan-name test-plan \ + --plan-type CLOUDFORMATION \ + --product-id prod-cfrfxmraxxxxx \ + --provisioned-product-name test-pp \ + --provisioning-artifact-id pa-7wz4cu5cxxxxx + +Output:: + + { + "PlanName": "test-plan", + "PlanId": "plan-cuxae3z6glaui", + "ProvisionProductId": "pp-7kh7wbc4xxxxx", + "ProvisionedProductName": "test-params", + "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx" + } diff --git a/awscli/examples/servicecatalog/delete-constraint.rst b/awscli/examples/servicecatalog/delete-constraint.rst new file mode 100644 index 000000000000..9351745d23b8 --- /dev/null +++ b/awscli/examples/servicecatalog/delete-constraint.rst @@ -0,0 +1,8 @@ +**To delete a constraint** + +The following ``delete-constraint`` example deletes a constraint. :: + + aws servicecatalog delete-constraint \ + --constraint-id cons-7tr6gei4bfx2g + +This command produces no output. diff --git a/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst new file mode 100644 index 000000000000..1915b5970166 --- /dev/null +++ b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst @@ -0,0 +1,8 @@ +**To delete a provisioned product plan** + +The following ``delete-provisioned-product-plan`` example deletes a provisioned product plan. :: + + aws servicecatalog delete-provisioned-product-plan \ + --plan-id "plan-cuxae3z6glaui + +This command produces no output. \ No newline at end of file diff --git a/awscli/examples/servicecatalog/describe-constraint.rst b/awscli/examples/servicecatalog/describe-constraint.rst new file mode 100644 index 000000000000..bb99a4bde9d1 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-constraint.rst @@ -0,0 +1,20 @@ +**To describe a constraint** + +The following ``describe-constraint`` example describes a constraint. :: + + aws servicecatalog describe-constraint \ + --id "cons-oqp52evr4bfx2g" + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-7tr6gei4bfx2g", + "Type": "LAUNCH", + "Owner": "123456789012", + "ProductId": "prod-cfrfxmra3vnu4", + "PortfolioId": "port-y3fnkeslpoevg" + }, + "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", + "Status": "AVAILABLE" + } \ No newline at end of file diff --git a/awscli/examples/servicecatalog/describe-portfolio-share-status.rst b/awscli/examples/servicecatalog/describe-portfolio-share-status.rst new file mode 100644 index 000000000000..8ab63c086f4c --- /dev/null +++ b/awscli/examples/servicecatalog/describe-portfolio-share-status.rst @@ -0,0 +1,21 @@ +**To describe portfolio share status** + +The following ``describe-portfolio-share-status`` example describes portfolio share status. :: + + aws servicecatalog describe-portfolio-share-status \ + --portfolio-share-token "share-agngcybu4uufe" + +Output:: + + { + "PortfolioShareToken": "share-agngcybu4uufe", + "PortfolioId": "port-y3fnkeslxxxxx", + "OrganizationNodeValue": "123456789012", + "Status": "COMPLETED", + "ShareDetails": { + "SuccessfulShares": [ + "210987654321" + ], + "ShareErrors": [] + } + } diff --git a/awscli/examples/servicecatalog/describe-portfolio-shares.rst b/awscli/examples/servicecatalog/describe-portfolio-shares.rst new file mode 100644 index 000000000000..72e3a647544f --- /dev/null +++ b/awscli/examples/servicecatalog/describe-portfolio-shares.rst @@ -0,0 +1,28 @@ +**To describe portfolio shares** + +The following ``describe-portfolio-shares`` example describes portfolio shares. :: + + aws servicecatalog describe-portfolio-shares \ + --portfolio-id port-y3fnkeslxxxxx \ + --type ACCOUNT + +Output:: + + { + "PortfolioShareDetails": [ + { + "PrincipalId": "012345678901", + "Type": "ACCOUNT", + "Accepted": true, + "ShareTagOptions": false, + "SharePrincipals": false + }, + { + "PrincipalId": "098765432109", + "Type": "ACCOUNT", + "Accepted": false, + "ShareTagOptions": false, + "SharePrincipals": false + } + ] + } diff --git a/awscli/examples/servicecatalog/describe-product.rst b/awscli/examples/servicecatalog/describe-product.rst new file mode 100644 index 000000000000..2a446fbe3751 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-product.rst @@ -0,0 +1,52 @@ +**To describe a product** + +The following ``describe-product`` example describes a product. :: + + aws servicecatalog describe-product \ + --id prod-dybl43puxxxxx + +Output:: + + { + "ProductViewSummary": { + "Id": "prodview-vkvy2kum5ojky", + "ProductId": "prod-dybl43puxxxxx", + "Name": "ec2-test", + "Owner": "user", + "ShortDescription": "", + "Type": "CLOUD_FORMATION_TEMPLATE", + "Distributor": "", + "HasDefaultPath": false, + "SupportEmail": "", + "SupportDescription": "", + "SupportUrl": "" + }, + "ProvisioningArtifacts": [ + { + "Id": "pa-j7fs6ybztfwm6", + "Name": "v2", + "Description": "", + "CreatedTime": "2021-07-16T15:20:24-05:00", + "Guidance": "DEFAULT" + }, + { + "Id": "pa-s6z7i2nivoxtm", + "Description": "Create EC2 and KMS", + "CreatedTime": "2024-06-13T18:27:54-05:00", + "Guidance": "DEFAULT" + }, + { + "Id": "pa-6573v3blon27u", + "Name": "v3", + "CreatedTime": "2024-06-13T18:45:14-05:00", + "Guidance": "DEFAULT" + } + ], + "Budgets": [], + "LaunchPaths": [ + { + "Id": "lpv3-y3fnkeslpoevg", + "Name": "TestPort" + } + ] + } diff --git a/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst b/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst new file mode 100644 index 000000000000..87a774bc9fd6 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst @@ -0,0 +1,25 @@ +**To describe a provisioned product plan** + +The following ``describe-provisioned-product-plan`` example describes a provisioned product plan. :: + + aws servicecatalog describe-provisioned-product-plan \ + --plan-id "plan-g7iwsaf3mytwu" + +Output:: + + { + "ProvisionedProductPlanDetails": { + "CreatedTime": "2025-11-09T18:09:37.808000-06:00", + "PathId": "lpv3-y3fnkeslpoevg", + "ProductId": "prod-cfrfxmraxxxxx", + "PlanName": "test-plan", + "PlanId": "plan-g7iwsaf3mytwu", + "ProvisionProductId": "pp-mkbnbztzxxxxx", + "ProvisionProductName": "test-pp", + "PlanType": "CLOUDFORMATION", + "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx", + "Status": "CREATE_SUCCESS", + "UpdatedTime": "2025-11-09T18:09:46.524000-06:00", + "Tags": [] + } + } diff --git a/awscli/examples/servicecatalog/describe-provisioning-parameters.rst b/awscli/examples/servicecatalog/describe-provisioning-parameters.rst new file mode 100644 index 000000000000..2a34bb2d3763 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-provisioning-parameters.rst @@ -0,0 +1,63 @@ +**To describe provisioning parameters** + +The following ``describe-provisioning-parameters`` example describes provisioning parameters. :: + + aws servicecatalog describe-provisioning-parameters \ + --product-id prod-cfrfxmraxxxxx \ + --provisioning-artifact-id pa-7wz4cu5cxxxxx \ + --path-id lpv3-y3fnkeslpoevg + +Output:: + + { + "ProvisioningArtifactParameters": [ + { + "ParameterKey": "Size", + "ParameterType": "String", + "IsNoEcho": false, + "ParameterConstraints": { + "AllowedValues": [] + } + } + ], + "ConstraintSummaries": [ + { + "Type": "LAUNCH" + } + ], + "UsageInstructions": [ + { + "Type": "rules", + "Value": "{}" + }, + { + "Type": "version", + "Value": "2010-09-09" + }, + { + "Type": "launchAsRole", + "Value": "arn:aws:iam::123456789012:role/NewLaunchRole" + }, + { + "Type": "tagUpdateOnProvisionedProduct", + "Value": "NOT_ALLOWED" + } + ], + "TagOptions": [ + { + "Key": "Application Name", + "Values": [ + "Testing Tag", + "Testing Tag Options" + ] + } + ], + "ProvisioningArtifactPreferences": {}, + "ProvisioningArtifactOutputs": [ + { + "Key": "pa-7wz4cu5cxxxxx", + "Description": "" + } + ], + "ProvisioningArtifactOutputKeys": [] + } diff --git a/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst b/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst new file mode 100644 index 000000000000..943708a143d5 --- /dev/null +++ b/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst @@ -0,0 +1,52 @@ +**Example 1: To list all constraints for a portfolio** + +The following ``list-constraints-for-portfolio`` example lists all constraints for a portfolio. :: + + aws servicecatalog list-constraints-for-portfolio \ + --portfolio-id port-y3fnkeslpoevg + +Output:: + + { + "ConstraintDetails": [ + { + "ConstraintId": "cons-dgdyqdqrxx4bq", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + }, + { + "ConstraintId": "cons-tzxjnj4l6yvck", + "Type": "RESOURCE_UPDATE", + "Owner": "123456789012", + "ProductId": "prod-sphewkokxxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + } + ] + } + + +**Example 2: To list constraints on a product** + +The following ``list-constraints-for-portfolio`` example lists constraints on a product. :: + + aws servicecatalog list-constraints-for-portfolio \ + --portfolio-id port-y3fnkeslxxxxx \ + --product-id prod-j6pd3hf6xxxxx + +Output:: + + { + "ConstraintDetails": [ + { + "ConstraintId": "cons-dgdyqdqrxx4bq", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + } + ] + } diff --git a/awscli/examples/servicecatalog/list-launch-paths.rst b/awscli/examples/servicecatalog/list-launch-paths.rst new file mode 100644 index 000000000000..240070542858 --- /dev/null +++ b/awscli/examples/servicecatalog/list-launch-paths.rst @@ -0,0 +1,23 @@ +**To list launch paths** + +The following ``list-launch-paths`` example lists launch paths for a portfolio. :: + + aws servicecatalog list-launch-paths \ + --product-id prod-cfrfxmraxxxxx + +Output:: + + { + "LaunchPathSummaries": [ + { + "Id": "lpv3-y3fnkeslpoevg", + "ConstraintSummaries": [ + { + "Type": "LAUNCH" + } + ], + "Tags": [], + "Name": "TestPort" + } + ] + } diff --git a/awscli/examples/servicecatalog/search-products.rst b/awscli/examples/servicecatalog/search-products.rst new file mode 100644 index 000000000000..2b2ecdf107c1 --- /dev/null +++ b/awscli/examples/servicecatalog/search-products.rst @@ -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. :: + + aws servicecatalog search-products + +Output:: + + { + "ProductViewSummaries": [ + { + "Id": "prodview-5uksdh4xxxxxx", + "ProductId": "prod-j6fu3hxxxxxxxx", + "Name": "TestSC", + "Owner": "test", + "ShortDescription": "", + "Type": "CLOUD_FORMATION_TEMPLATE", + "Distributor": "", + "HasDefaultPath": false, + "SupportEmail": "", + "SupportDescription": "", + "SupportUrl": "" + }, + { + "Id": "prodview-3kfoaabxxxxxx", + "ProductId": "prod-j6pd3xxxxxxxx", + "Name": "TestProduct", + "Owner": "test_owner", + "ShortDescription": "", + "Type": "CLOUD_FORMATION_TEMPLATE", + "Distributor": "", + "HasDefaultPath": false, + "SupportEmail": "", + "SupportDescription": "", + "SupportUrl": "" + } + ] + } diff --git a/awscli/examples/servicecatalog/terminate-provisioned-product.rst b/awscli/examples/servicecatalog/terminate-provisioned-product.rst new file mode 100644 index 000000000000..79db46780e6d --- /dev/null +++ b/awscli/examples/servicecatalog/terminate-provisioned-product.rst @@ -0,0 +1,28 @@ +**To terminate a provisioned product** + +The following ``terminate-provisioned-product`` example terminates a provisioned product. :: + + aws servicecatalog terminate-provisioned-product \ + --provisioned-product-id pp-7z4t3k4hxxxxx +{ + +Output:: + + { + "RecordDetail": { + "RecordId": "rec-sbwnhzld3b2ku", + "ProvisionedProductName": "test2", + "Status": "CREATED", + "CreatedTime": "2025-12-31T15:23:55.051000-06:00", + "UpdatedTime": "2025-12-31T15:23:55.051000-06:00", + "ProvisionedProductType": "CFN_STACK", + "RecordType": "TERMINATE_PROVISIONED_PRODUCT", + "ProvisionedProductId": "pp-7z4t3k4hxxxxx", + "ProductId": "prod-j6pd3hf6xxxxx", + "ProvisioningArtifactId": "pa-sbhovlh7w7nns", + "PathId": "lpv3-y3fnkeslpoevg", + "RecordErrors": [], + "RecordTags": [], + "LaunchRoleArn": "arn:aws:iam::123456789012:role/TestLaunchRole" + } + } diff --git a/awscli/examples/servicecatalog/update-constraint.rst b/awscli/examples/servicecatalog/update-constraint.rst new file mode 100644 index 000000000000..bf03a9fe3845 --- /dev/null +++ b/awscli/examples/servicecatalog/update-constraint.rst @@ -0,0 +1,22 @@ +**To update a constraint** + +The following ``update-constraint`` example updates a constraint. :: + + aws servicecatalog update-constraint \ + --id cons-dgdyqdqrxx4bq \ + --parameters '{"LocalRoleName": "TestLaunchRole"}' + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-dgdyqdqrxx4bq", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + }, + "ConstraintParameters": "{\"LocalRoleName\": \"TestLaunchRole\"}", + "Status": "CREATING" + } From 77f7929dfd12f3fd8fc3db86cea777392ebc8ed0 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:48:01 -0500 Subject: [PATCH 02/22] Fix constraint creation example in documentation Corrected the heading and updated example parameters and output values. --- .../examples/servicecatalog/create-contraint.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/awscli/examples/servicecatalog/create-contraint.rst b/awscli/examples/servicecatalog/create-contraint.rst index 169d565f09ad..93a8f68088b8 100644 --- a/awscli/examples/servicecatalog/create-contraint.rst +++ b/awscli/examples/servicecatalog/create-contraint.rst @@ -1,4 +1,4 @@ -**To create a constraint** +**To create a constraints** The following ``create-constraint`` example creates a constraint. :: @@ -6,18 +6,20 @@ The following ``create-constraint`` example creates a constraint. :: --portfolio-id port-y3fnkesxxxxx \ --product-id prod-cfrfxmraxxxxx \ --type LAUNCH \ - --parameters '{"RoleArn" : "arn:aws:iam::123456789012:role/NewLaunchRole"}' + --parameters '{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}' Output:: { "ConstraintDetail": { - "ConstraintId": "cons-7tr6gei4bfx2g", + "ConstraintId": "cons-7tr6gei4bxxxx", "Type": "LAUNCH", "Owner": "123456789012", - "ProductId": "prod-cfrfxmra3vnu4", - "PortfolioId": "port-y3fnkeslpoevg" + "ProductId": "prod-cfrfxmra3xxxx", + "PortfolioId": "port-y3fnkeslpxxxx" }, "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", "Status": "CREATING" - } \ No newline at end of file + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. From 50cfdb1116bdb4491a5b25f303ab00f0018e4f8b Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:49:20 -0500 Subject: [PATCH 03/22] Rename create-contraint.rst to create-constraint.rst --- .../{create-contraint.rst => create-constraint.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename awscli/examples/servicecatalog/{create-contraint.rst => create-constraint.rst} (100%) diff --git a/awscli/examples/servicecatalog/create-contraint.rst b/awscli/examples/servicecatalog/create-constraint.rst similarity index 100% rename from awscli/examples/servicecatalog/create-contraint.rst rename to awscli/examples/servicecatalog/create-constraint.rst From 086c25102553fe16a391e954845022c141d0e2bd Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:51:22 -0500 Subject: [PATCH 04/22] Modify delete-constraint example with new constraint ID Updated the constraint ID in the delete-constraint example and added a reference to the AWS Service Catalog User Guide. --- awscli/examples/servicecatalog/delete-constraint.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/delete-constraint.rst b/awscli/examples/servicecatalog/delete-constraint.rst index 9351745d23b8..3b26cecceacb 100644 --- a/awscli/examples/servicecatalog/delete-constraint.rst +++ b/awscli/examples/servicecatalog/delete-constraint.rst @@ -3,6 +3,8 @@ The following ``delete-constraint`` example deletes a constraint. :: aws servicecatalog delete-constraint \ - --constraint-id cons-7tr6gei4bfx2g + --constraint-id cons-7tr6gei4bxxxx This command produces no output. + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. From 81d5f4b20cf4a542c3993e4a5e6c87b837b0d14d Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:52:38 -0500 Subject: [PATCH 05/22] Fix example IDs in describe-constraint.rst Updated example IDs in describe-constraint documentation. --- .../examples/servicecatalog/describe-constraint.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/awscli/examples/servicecatalog/describe-constraint.rst b/awscli/examples/servicecatalog/describe-constraint.rst index bb99a4bde9d1..b6cc856ef4b9 100644 --- a/awscli/examples/servicecatalog/describe-constraint.rst +++ b/awscli/examples/servicecatalog/describe-constraint.rst @@ -3,18 +3,20 @@ The following ``describe-constraint`` example describes a constraint. :: aws servicecatalog describe-constraint \ - --id "cons-oqp52evr4bfx2g" + --id "cons-oqp52evr4bxxxx" Output:: { "ConstraintDetail": { - "ConstraintId": "cons-7tr6gei4bfx2g", + "ConstraintId": "cons-7tr6gei4bxxxx", "Type": "LAUNCH", "Owner": "123456789012", - "ProductId": "prod-cfrfxmra3vnu4", - "PortfolioId": "port-y3fnkeslpoevg" + "ProductId": "prod-cfrfxmra3xxxx", + "PortfolioId": "port-y3fnkeslpxxxx" }, "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", "Status": "AVAILABLE" - } \ No newline at end of file + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. From 17f7cffccda9a51a22d88d799708e367faa843ab Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:57:11 -0500 Subject: [PATCH 06/22] Revise list-constraints-for-portfolio example output Updated example output for list-constraints-for-portfolio command and added reference to AWS documentation. --- .../servicecatalog/list-constraints-for-portfolio.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst b/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst index 943708a143d5..a04cda92f002 100644 --- a/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst +++ b/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst @@ -3,14 +3,14 @@ The following ``list-constraints-for-portfolio`` example lists all constraints for a portfolio. :: aws servicecatalog list-constraints-for-portfolio \ - --portfolio-id port-y3fnkeslpoevg + --portfolio-id port-y3fnkeslpxxxx Output:: { "ConstraintDetails": [ { - "ConstraintId": "cons-dgdyqdqrxx4bq", + "ConstraintId": "cons-dgdyqdqrxxxxx", "Type": "LAUNCH", "Description": "Launch as local role TestLaunchRole", "Owner": "123456789012", @@ -18,7 +18,7 @@ Output:: "PortfolioId": "port-y3fnkeslxxxxx" }, { - "ConstraintId": "cons-tzxjnj4l6yvck", + "ConstraintId": "cons-tzxjnj4l6xxxx", "Type": "RESOURCE_UPDATE", "Owner": "123456789012", "ProductId": "prod-sphewkokxxxxx", @@ -41,7 +41,7 @@ Output:: { "ConstraintDetails": [ { - "ConstraintId": "cons-dgdyqdqrxx4bq", + "ConstraintId": "cons-dgdyqdqrxxxxx", "Type": "LAUNCH", "Description": "Launch as local role TestLaunchRole", "Owner": "123456789012", @@ -50,3 +50,5 @@ Output:: } ] } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. From 7f41c46c60eddf54ae1f590d8896c046c835308a Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 20:58:36 -0500 Subject: [PATCH 07/22] Change constraint ID in update-constraint example Updated the constraint ID in the update-constraint example. --- awscli/examples/servicecatalog/update-constraint.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/awscli/examples/servicecatalog/update-constraint.rst b/awscli/examples/servicecatalog/update-constraint.rst index bf03a9fe3845..6cb701116e31 100644 --- a/awscli/examples/servicecatalog/update-constraint.rst +++ b/awscli/examples/servicecatalog/update-constraint.rst @@ -3,14 +3,14 @@ The following ``update-constraint`` example updates a constraint. :: aws servicecatalog update-constraint \ - --id cons-dgdyqdqrxx4bq \ + --id cons-dgdyqdqrxxxxx \ --parameters '{"LocalRoleName": "TestLaunchRole"}' Output:: { "ConstraintDetail": { - "ConstraintId": "cons-dgdyqdqrxx4bq", + "ConstraintId": "cons-dgdyqdqrxxxxx", "Type": "LAUNCH", "Description": "Launch as local role TestLaunchRole", "Owner": "123456789012", @@ -20,3 +20,5 @@ Output:: "ConstraintParameters": "{\"LocalRoleName\": \"TestLaunchRole\"}", "Status": "CREATING" } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. From b4d8420f12299d87baebaee2bf6aadfd15a3d9e3 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:12:49 -0500 Subject: [PATCH 08/22] Update PlanId in create-provisioned-product-plan.rst --- .../examples/servicecatalog/create-provisioned-product-plan.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst index c82da146fd62..c3a5ab9cadcf 100644 --- a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst @@ -13,7 +13,7 @@ Output:: { "PlanName": "test-plan", - "PlanId": "plan-cuxae3z6glaui", + "PlanId": "plan-cuxae3z6gxxxx", "ProvisionProductId": "pp-7kh7wbc4xxxxx", "ProvisionedProductName": "test-params", "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx" From 4508265a00ed064a57baf694fc3343f83cfb5fb3 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:13:47 -0500 Subject: [PATCH 09/22] Update example plan ID in delete-provisioned-product-plan --- .../servicecatalog/delete-provisioned-product-plan.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst index 1915b5970166..0b12f970a472 100644 --- a/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst @@ -3,6 +3,6 @@ The following ``delete-provisioned-product-plan`` example deletes a provisioned product plan. :: aws servicecatalog delete-provisioned-product-plan \ - --plan-id "plan-cuxae3z6glaui + --plan-id "plan-cuxae3z6gxxxx -This command produces no output. \ No newline at end of file +This command produces no output. From 3c0d70950ac3d97085e45be0151f4f1183cb8c0c Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:16:41 -0500 Subject: [PATCH 10/22] Update example for describe-portfolio-share-status Updated the portfolio share token in the example and added a reference to the AWS documentation. --- .../servicecatalog/describe-portfolio-share-status.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/awscli/examples/servicecatalog/describe-portfolio-share-status.rst b/awscli/examples/servicecatalog/describe-portfolio-share-status.rst index 8ab63c086f4c..56ac229edef3 100644 --- a/awscli/examples/servicecatalog/describe-portfolio-share-status.rst +++ b/awscli/examples/servicecatalog/describe-portfolio-share-status.rst @@ -3,12 +3,12 @@ The following ``describe-portfolio-share-status`` example describes portfolio share status. :: aws servicecatalog describe-portfolio-share-status \ - --portfolio-share-token "share-agngcybu4uufe" + --portfolio-share-token "share-agngcybu4xxxx" Output:: { - "PortfolioShareToken": "share-agngcybu4uufe", + "PortfolioShareToken": "share-agngcybu4xxxx", "PortfolioId": "port-y3fnkeslxxxxx", "OrganizationNodeValue": "123456789012", "Status": "COMPLETED", @@ -19,3 +19,5 @@ Output:: "ShareErrors": [] } } + +For more information, see `Sharing a Portfolio `__ in the *AWS Service Catalog User Guide*. From 312aa377bc603910df2eebbff7fe20f2c27b3855 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:19:13 -0500 Subject: [PATCH 11/22] Add reference link for portfolio sharing information Added a reference link to the AWS Service Catalog User Guide for portfolio sharing. --- awscli/examples/servicecatalog/describe-portfolio-shares.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/awscli/examples/servicecatalog/describe-portfolio-shares.rst b/awscli/examples/servicecatalog/describe-portfolio-shares.rst index 72e3a647544f..4ac4962a0cf2 100644 --- a/awscli/examples/servicecatalog/describe-portfolio-shares.rst +++ b/awscli/examples/servicecatalog/describe-portfolio-shares.rst @@ -26,3 +26,5 @@ Output:: } ] } + +For more information, see `Sharing a Portfolio `__ in the *AWS Service Catalog User Guide*. From 2990a13f50322c87dc26dfd9b1b75ebaaa0e1131 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:22:40 -0500 Subject: [PATCH 12/22] Update product IDs in describe-product.rst --- awscli/examples/servicecatalog/describe-product.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/awscli/examples/servicecatalog/describe-product.rst b/awscli/examples/servicecatalog/describe-product.rst index 2a446fbe3751..79a2cc664819 100644 --- a/awscli/examples/servicecatalog/describe-product.rst +++ b/awscli/examples/servicecatalog/describe-product.rst @@ -9,7 +9,7 @@ Output:: { "ProductViewSummary": { - "Id": "prodview-vkvy2kum5ojky", + "Id": "prodview-vkvy2kum5xxxx", "ProductId": "prod-dybl43puxxxxx", "Name": "ec2-test", "Owner": "user", @@ -23,20 +23,20 @@ Output:: }, "ProvisioningArtifacts": [ { - "Id": "pa-j7fs6ybztfwm6", + "Id": "pa-j7fs6ybztxxxx", "Name": "v2", "Description": "", "CreatedTime": "2021-07-16T15:20:24-05:00", "Guidance": "DEFAULT" }, { - "Id": "pa-s6z7i2nivoxtm", + "Id": "pa-s6z7i2nivxxxx", "Description": "Create EC2 and KMS", "CreatedTime": "2024-06-13T18:27:54-05:00", "Guidance": "DEFAULT" }, { - "Id": "pa-6573v3blon27u", + "Id": "pa-6573v3bloxxxx", "Name": "v3", "CreatedTime": "2024-06-13T18:45:14-05:00", "Guidance": "DEFAULT" @@ -45,8 +45,10 @@ Output:: "Budgets": [], "LaunchPaths": [ { - "Id": "lpv3-y3fnkeslpoevg", + "Id": "lpv3-y3fnkeslpxxxx", "Name": "TestPort" } ] } + +For more information, see `Managing Products `__ in the *AWS Service Catalog User Guide*. From e5c826e27c0c27526f7b4c567454ca80a3148bac Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:23:57 -0500 Subject: [PATCH 13/22] Update example plan ID and Path ID in documentation --- .../servicecatalog/describe-provisioned-product-plan.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst b/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst index 87a774bc9fd6..9e92fc763fb6 100644 --- a/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/describe-provisioned-product-plan.rst @@ -3,17 +3,17 @@ The following ``describe-provisioned-product-plan`` example describes a provisioned product plan. :: aws servicecatalog describe-provisioned-product-plan \ - --plan-id "plan-g7iwsaf3mytwu" + --plan-id "plan-g7iwsaf3mxxxx" Output:: { "ProvisionedProductPlanDetails": { "CreatedTime": "2025-11-09T18:09:37.808000-06:00", - "PathId": "lpv3-y3fnkeslpoevg", + "PathId": "lpv3-y3fnkeslpxxxx", "ProductId": "prod-cfrfxmraxxxxx", "PlanName": "test-plan", - "PlanId": "plan-g7iwsaf3mytwu", + "PlanId": "plan-g7iwsaf3mxxxx", "ProvisionProductId": "pp-mkbnbztzxxxxx", "ProvisionProductName": "test-pp", "PlanType": "CLOUDFORMATION", From 7bc036c2cbbbf8c532d1e41b8765d0cda4ea032e Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:27:51 -0500 Subject: [PATCH 14/22] Update path-id in describe-provisioning-parameters example --- .../servicecatalog/describe-provisioning-parameters.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/describe-provisioning-parameters.rst b/awscli/examples/servicecatalog/describe-provisioning-parameters.rst index 2a34bb2d3763..ad48491dd2dc 100644 --- a/awscli/examples/servicecatalog/describe-provisioning-parameters.rst +++ b/awscli/examples/servicecatalog/describe-provisioning-parameters.rst @@ -5,7 +5,7 @@ The following ``describe-provisioning-parameters`` example describes provisionin aws servicecatalog describe-provisioning-parameters \ --product-id prod-cfrfxmraxxxxx \ --provisioning-artifact-id pa-7wz4cu5cxxxxx \ - --path-id lpv3-y3fnkeslpoevg + --path-id lpv3-y3fnkeslpxxxx Output:: From f91fd184d37a48ede914fa3c96086536af039f5a Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:29:39 -0500 Subject: [PATCH 15/22] Update Launch Path ID in example documentation --- awscli/examples/servicecatalog/list-launch-paths.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/list-launch-paths.rst b/awscli/examples/servicecatalog/list-launch-paths.rst index 240070542858..f40b4cf2e582 100644 --- a/awscli/examples/servicecatalog/list-launch-paths.rst +++ b/awscli/examples/servicecatalog/list-launch-paths.rst @@ -10,7 +10,7 @@ Output:: { "LaunchPathSummaries": [ { - "Id": "lpv3-y3fnkeslpoevg", + "Id": "lpv3-y3fnkeslpxxxx", "ConstraintSummaries": [ { "Type": "LAUNCH" From 9f82347361122f7a6b9ea5079e98ea40f0629338 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:30:50 -0500 Subject: [PATCH 16/22] Add reference to AWS Service Catalog User Guide Added a reference to the AWS Service Catalog User Guide for managing products. --- awscli/examples/servicecatalog/search-products.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/awscli/examples/servicecatalog/search-products.rst b/awscli/examples/servicecatalog/search-products.rst index 2b2ecdf107c1..051de93733e8 100644 --- a/awscli/examples/servicecatalog/search-products.rst +++ b/awscli/examples/servicecatalog/search-products.rst @@ -36,3 +36,5 @@ Output:: } ] } + +For more information, see `Managing Products `__ in the *AWS Service Catalog User Guide*. From 0d0c77768ddf35107c6ba91c0abd8de4d5e6a1c0 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:32:26 -0500 Subject: [PATCH 17/22] Modify terminate-provisioned-product example output Updated example output with new RecordId, ProvisioningArtifactId, and PathId. --- .../servicecatalog/terminate-provisioned-product.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/awscli/examples/servicecatalog/terminate-provisioned-product.rst b/awscli/examples/servicecatalog/terminate-provisioned-product.rst index 79db46780e6d..8b46512e90ca 100644 --- a/awscli/examples/servicecatalog/terminate-provisioned-product.rst +++ b/awscli/examples/servicecatalog/terminate-provisioned-product.rst @@ -10,7 +10,7 @@ Output:: { "RecordDetail": { - "RecordId": "rec-sbwnhzld3b2ku", + "RecordId": "rec-sbwnhzld3xxxx", "ProvisionedProductName": "test2", "Status": "CREATED", "CreatedTime": "2025-12-31T15:23:55.051000-06:00", @@ -19,10 +19,12 @@ Output:: "RecordType": "TERMINATE_PROVISIONED_PRODUCT", "ProvisionedProductId": "pp-7z4t3k4hxxxxx", "ProductId": "prod-j6pd3hf6xxxxx", - "ProvisioningArtifactId": "pa-sbhovlh7w7nns", - "PathId": "lpv3-y3fnkeslpoevg", + "ProvisioningArtifactId": "pa-sbhovlh7wxxxx", + "PathId": "lpv3-y3fnkeslpxxxx", "RecordErrors": [], "RecordTags": [], "LaunchRoleArn": "arn:aws:iam::123456789012:role/TestLaunchRole" } } + +For more information, see `Managing Provisioned Products `__ in the *AWS Service Catalog User Guide*. From 951028040dc1729206693ef0adecf18a52876f37 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:34:12 -0500 Subject: [PATCH 18/22] Update awscli/examples/servicecatalog/search-products.rst Co-authored-by: Kenneth Daily --- awscli/examples/servicecatalog/search-products.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/search-products.rst b/awscli/examples/servicecatalog/search-products.rst index 051de93733e8..d023b443abc8 100644 --- a/awscli/examples/servicecatalog/search-products.rst +++ b/awscli/examples/servicecatalog/search-products.rst @@ -1,4 +1,4 @@ -**To get information about the products to which the caller has access* +**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. :: From 817292322712c516107f4eb0f6c8e989c6025269 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:34:54 -0500 Subject: [PATCH 19/22] Update awscli/examples/servicecatalog/search-products.rst Co-authored-by: Kenneth Daily --- awscli/examples/servicecatalog/search-products.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/search-products.rst b/awscli/examples/servicecatalog/search-products.rst index d023b443abc8..0485963e4978 100644 --- a/awscli/examples/servicecatalog/search-products.rst +++ b/awscli/examples/servicecatalog/search-products.rst @@ -1,6 +1,6 @@ **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. :: +The following ``search-products`` example gets all the products the caller has access to. :: aws servicecatalog search-products From 9f21f7fcf7e63ac5418511f1cfb1ba6a2a336e38 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:36:24 -0500 Subject: [PATCH 20/22] Update ProvisionedProductName in example --- .../examples/servicecatalog/create-provisioned-product-plan.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst index c3a5ab9cadcf..0ed32f60e753 100644 --- a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst @@ -15,6 +15,6 @@ Output:: "PlanName": "test-plan", "PlanId": "plan-cuxae3z6gxxxx", "ProvisionProductId": "pp-7kh7wbc4xxxxx", - "ProvisionedProductName": "test-params", + "ProvisionedProductName": "test-pp", "ProvisioningArtifactId": "pa-7wz4cu5cxxxxx" } From afe3beacbe97fe22129bc340440a5766b020edc7 Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:37:04 -0500 Subject: [PATCH 21/22] Fix formatting in create-provisioned-product-plan example --- .../examples/servicecatalog/create-provisioned-product-plan.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst index 0ed32f60e753..9432fb11349c 100644 --- a/awscli/examples/servicecatalog/create-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/create-provisioned-product-plan.rst @@ -2,7 +2,7 @@ The following ``create-provisioned-product-plan`` example creates a plan. :: - aws servicecatalog create-provisioned-product-plan \ + aws servicecatalog create-provisioned-product-plan \ --plan-name test-plan \ --plan-type CLOUDFORMATION \ --product-id prod-cfrfxmraxxxxx \ From d984592e70f986c182db468f13f0f6ac54f6026d Mon Sep 17 00:00:00 2001 From: eodeyemi14 <84422131+eodeyemi14@users.noreply.github.com> Date: Tue, 5 May 2026 21:39:42 -0500 Subject: [PATCH 22/22] Fix example by removing quotes from plan ID Removed unnecessary quotes around the plan ID in the example. --- .../examples/servicecatalog/delete-provisioned-product-plan.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst index 0b12f970a472..69050d863ffc 100644 --- a/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst +++ b/awscli/examples/servicecatalog/delete-provisioned-product-plan.rst @@ -3,6 +3,6 @@ The following ``delete-provisioned-product-plan`` example deletes a provisioned product plan. :: aws servicecatalog delete-provisioned-product-plan \ - --plan-id "plan-cuxae3z6gxxxx + --plan-id plan-cuxae3z6gxxxx This command produces no output.