diff --git a/awscli/examples/servicecatalog/create-constraint.rst b/awscli/examples/servicecatalog/create-constraint.rst new file mode 100644 index 000000000000..93a8f68088b8 --- /dev/null +++ b/awscli/examples/servicecatalog/create-constraint.rst @@ -0,0 +1,25 @@ +**To create a constraints** + +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/LaunchRole"}' + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-7tr6gei4bxxxx", + "Type": "LAUNCH", + "Owner": "123456789012", + "ProductId": "prod-cfrfxmra3xxxx", + "PortfolioId": "port-y3fnkeslpxxxx" + }, + "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", + "Status": "CREATING" + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. 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..9432fb11349c --- /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-cuxae3z6gxxxx", + "ProvisionProductId": "pp-7kh7wbc4xxxxx", + "ProvisionedProductName": "test-pp", + "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..3b26cecceacb --- /dev/null +++ b/awscli/examples/servicecatalog/delete-constraint.rst @@ -0,0 +1,10 @@ +**To delete a constraint** + +The following ``delete-constraint`` example deletes a constraint. :: + + aws servicecatalog delete-constraint \ + --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*. 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..69050d863ffc --- /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-cuxae3z6gxxxx + +This command produces no output. diff --git a/awscli/examples/servicecatalog/describe-constraint.rst b/awscli/examples/servicecatalog/describe-constraint.rst new file mode 100644 index 000000000000..b6cc856ef4b9 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-constraint.rst @@ -0,0 +1,22 @@ +**To describe a constraint** + +The following ``describe-constraint`` example describes a constraint. :: + + aws servicecatalog describe-constraint \ + --id "cons-oqp52evr4bxxxx" + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-7tr6gei4bxxxx", + "Type": "LAUNCH", + "Owner": "123456789012", + "ProductId": "prod-cfrfxmra3xxxx", + "PortfolioId": "port-y3fnkeslpxxxx" + }, + "ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}", + "Status": "AVAILABLE" + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. 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..56ac229edef3 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-portfolio-share-status.rst @@ -0,0 +1,23 @@ +**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-agngcybu4xxxx" + +Output:: + + { + "PortfolioShareToken": "share-agngcybu4xxxx", + "PortfolioId": "port-y3fnkeslxxxxx", + "OrganizationNodeValue": "123456789012", + "Status": "COMPLETED", + "ShareDetails": { + "SuccessfulShares": [ + "210987654321" + ], + "ShareErrors": [] + } + } + +For more information, see `Sharing a Portfolio `__ in the *AWS Service Catalog User Guide*. diff --git a/awscli/examples/servicecatalog/describe-portfolio-shares.rst b/awscli/examples/servicecatalog/describe-portfolio-shares.rst new file mode 100644 index 000000000000..4ac4962a0cf2 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-portfolio-shares.rst @@ -0,0 +1,30 @@ +**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 + } + ] + } + +For more information, see `Sharing a Portfolio `__ in the *AWS Service Catalog User Guide*. diff --git a/awscli/examples/servicecatalog/describe-product.rst b/awscli/examples/servicecatalog/describe-product.rst new file mode 100644 index 000000000000..79a2cc664819 --- /dev/null +++ b/awscli/examples/servicecatalog/describe-product.rst @@ -0,0 +1,54 @@ +**To describe a product** + +The following ``describe-product`` example describes a product. :: + + aws servicecatalog describe-product \ + --id prod-dybl43puxxxxx + +Output:: + + { + "ProductViewSummary": { + "Id": "prodview-vkvy2kum5xxxx", + "ProductId": "prod-dybl43puxxxxx", + "Name": "ec2-test", + "Owner": "user", + "ShortDescription": "", + "Type": "CLOUD_FORMATION_TEMPLATE", + "Distributor": "", + "HasDefaultPath": false, + "SupportEmail": "", + "SupportDescription": "", + "SupportUrl": "" + }, + "ProvisioningArtifacts": [ + { + "Id": "pa-j7fs6ybztxxxx", + "Name": "v2", + "Description": "", + "CreatedTime": "2021-07-16T15:20:24-05:00", + "Guidance": "DEFAULT" + }, + { + "Id": "pa-s6z7i2nivxxxx", + "Description": "Create EC2 and KMS", + "CreatedTime": "2024-06-13T18:27:54-05:00", + "Guidance": "DEFAULT" + }, + { + "Id": "pa-6573v3bloxxxx", + "Name": "v3", + "CreatedTime": "2024-06-13T18:45:14-05:00", + "Guidance": "DEFAULT" + } + ], + "Budgets": [], + "LaunchPaths": [ + { + "Id": "lpv3-y3fnkeslpxxxx", + "Name": "TestPort" + } + ] + } + +For more information, see `Managing Products `__ in the *AWS Service Catalog User Guide*. 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..9e92fc763fb6 --- /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-g7iwsaf3mxxxx" + +Output:: + + { + "ProvisionedProductPlanDetails": { + "CreatedTime": "2025-11-09T18:09:37.808000-06:00", + "PathId": "lpv3-y3fnkeslpxxxx", + "ProductId": "prod-cfrfxmraxxxxx", + "PlanName": "test-plan", + "PlanId": "plan-g7iwsaf3mxxxx", + "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..ad48491dd2dc --- /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-y3fnkeslpxxxx + +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..a04cda92f002 --- /dev/null +++ b/awscli/examples/servicecatalog/list-constraints-for-portfolio.rst @@ -0,0 +1,54 @@ +**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-y3fnkeslpxxxx + +Output:: + + { + "ConstraintDetails": [ + { + "ConstraintId": "cons-dgdyqdqrxxxxx", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + }, + { + "ConstraintId": "cons-tzxjnj4l6xxxx", + "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-dgdyqdqrxxxxx", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + } + ] + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*. diff --git a/awscli/examples/servicecatalog/list-launch-paths.rst b/awscli/examples/servicecatalog/list-launch-paths.rst new file mode 100644 index 000000000000..f40b4cf2e582 --- /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-y3fnkeslpxxxx", + "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..0485963e4978 --- /dev/null +++ b/awscli/examples/servicecatalog/search-products.rst @@ -0,0 +1,40 @@ +**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": "" + } + ] + } + +For more information, see `Managing Products `__ in the *AWS Service Catalog User Guide*. diff --git a/awscli/examples/servicecatalog/terminate-provisioned-product.rst b/awscli/examples/servicecatalog/terminate-provisioned-product.rst new file mode 100644 index 000000000000..8b46512e90ca --- /dev/null +++ b/awscli/examples/servicecatalog/terminate-provisioned-product.rst @@ -0,0 +1,30 @@ +**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-sbwnhzld3xxxx", + "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-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*. diff --git a/awscli/examples/servicecatalog/update-constraint.rst b/awscli/examples/servicecatalog/update-constraint.rst new file mode 100644 index 000000000000..6cb701116e31 --- /dev/null +++ b/awscli/examples/servicecatalog/update-constraint.rst @@ -0,0 +1,24 @@ +**To update a constraint** + +The following ``update-constraint`` example updates a constraint. :: + + aws servicecatalog update-constraint \ + --id cons-dgdyqdqrxxxxx \ + --parameters '{"LocalRoleName": "TestLaunchRole"}' + +Output:: + + { + "ConstraintDetail": { + "ConstraintId": "cons-dgdyqdqrxxxxx", + "Type": "LAUNCH", + "Description": "Launch as local role TestLaunchRole", + "Owner": "123456789012", + "ProductId": "prod-j6pd3hf6xxxxx", + "PortfolioId": "port-y3fnkeslxxxxx" + }, + "ConstraintParameters": "{\"LocalRoleName\": \"TestLaunchRole\"}", + "Status": "CREATING" + } + +For more information, see `Using AWS Service Catalog Constraints `__ in the *AWS Service Catalog User Guide*.