Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
49a622b
update servicecatalog cli docs
eodeyemi14 Dec 31, 2025
77f7929
Fix constraint creation example in documentation
eodeyemi14 May 6, 2026
50cfdb1
Rename create-contraint.rst to create-constraint.rst
eodeyemi14 May 6, 2026
086c251
Modify delete-constraint example with new constraint ID
eodeyemi14 May 6, 2026
81d5f4b
Fix example IDs in describe-constraint.rst
eodeyemi14 May 6, 2026
17f7cff
Revise list-constraints-for-portfolio example output
eodeyemi14 May 6, 2026
7f41c46
Change constraint ID in update-constraint example
eodeyemi14 May 6, 2026
b4d8420
Update PlanId in create-provisioned-product-plan.rst
eodeyemi14 May 6, 2026
4508265
Update example plan ID in delete-provisioned-product-plan
eodeyemi14 May 6, 2026
3c0d709
Update example for describe-portfolio-share-status
eodeyemi14 May 6, 2026
312aa37
Add reference link for portfolio sharing information
eodeyemi14 May 6, 2026
2990a13
Update product IDs in describe-product.rst
eodeyemi14 May 6, 2026
e5c826e
Update example plan ID and Path ID in documentation
eodeyemi14 May 6, 2026
7bc036c
Update path-id in describe-provisioning-parameters example
eodeyemi14 May 6, 2026
f91fd18
Update Launch Path ID in example documentation
eodeyemi14 May 6, 2026
9f82347
Add reference to AWS Service Catalog User Guide
eodeyemi14 May 6, 2026
0d0c777
Modify terminate-provisioned-product example output
eodeyemi14 May 6, 2026
9510280
Update awscli/examples/servicecatalog/search-products.rst
eodeyemi14 May 6, 2026
8172923
Update awscli/examples/servicecatalog/search-products.rst
eodeyemi14 May 6, 2026
9f21f7f
Update ProvisionedProductName in example
eodeyemi14 May 6, 2026
afe3bea
Fix formatting in create-provisioned-product-plan example
eodeyemi14 May 6, 2026
d984592
Fix example by removing quotes from plan ID
eodeyemi14 May 6, 2026
dad185a
Remove trailing whitespace
kdaily May 7, 2026
44bd6bb
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
d69bc75
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
8455b51
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
30f10e6
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
aad9141
Update successful share ID in describe-portfolio-share-status
eodeyemi14 May 7, 2026
593435e
Fix formatting in describe-portfolio-shares example
eodeyemi14 May 7, 2026
119a811
Update PrincipalId in describe-portfolio-shares.rst
eodeyemi14 May 7, 2026
583e666
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
4ae0e1f
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
798d6db
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
83f74f2
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
253e8d4
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
99f155c
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
753d50e
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
2f268f3
Apply suggestion from @kdaily
eodeyemi14 May 7, 2026
5aaaec9
Update PrincipalId in describe-portfolio-shares.rst
eodeyemi14 May 7, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions awscli/examples/servicecatalog/create-constraint.rst
Comment thread
eodeyemi14 marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html>`__ in the *AWS Service Catalog User Guide*.
20 changes: 20 additions & 0 deletions awscli/examples/servicecatalog/create-provisioned-product-plan.rst
Original file line number Diff line number Diff line change
@@ -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"
}
10 changes: 10 additions & 0 deletions awscli/examples/servicecatalog/delete-constraint.rst
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html>`__ in the *AWS Service Catalog User Guide*.
Original file line number Diff line number Diff line change
@@ -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.
22 changes: 22 additions & 0 deletions awscli/examples/servicecatalog/describe-constraint.rst
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html>`__ in the *AWS Service Catalog User Guide*.
23 changes: 23 additions & 0 deletions awscli/examples/servicecatalog/describe-portfolio-share-status.rst
Original file line number Diff line number Diff line change
@@ -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": [
"012345678901"
],
"ShareErrors": []
}
}

For more information, see `Sharing a Portfolio <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_sharing_how-to-share.html>`__ in the *AWS Service Catalog User Guide*.
30 changes: 30 additions & 0 deletions awscli/examples/servicecatalog/describe-portfolio-shares.rst
Original file line number Diff line number Diff line change
@@ -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": "123456789012",
"Type": "ACCOUNT",
"Accepted": true,
"ShareTagOptions": false,
"SharePrincipals": false
},
{
"PrincipalId": "123456789012",
"Type": "ACCOUNT",
"Accepted": false,
"ShareTagOptions": false,
"SharePrincipals": false
}
]
}

For more information, see `Sharing a Portfolio <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_portfolios_sharing_how-to-share.html>`__ in the *AWS Service Catalog User Guide*.
54 changes: 54 additions & 0 deletions awscli/examples/servicecatalog/describe-product.rst
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_products.html>`__ in the *AWS Service Catalog User Guide*.
Original file line number Diff line number Diff line change
@@ -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": []
}
}
Original file line number Diff line number Diff line change
@@ -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": []
}
54 changes: 54 additions & 0 deletions awscli/examples/servicecatalog/list-constraints-for-portfolio.rst
Original file line number Diff line number Diff line change
@@ -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 <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/constraints.html>`__ in the *AWS Service Catalog User Guide*.
23 changes: 23 additions & 0 deletions awscli/examples/servicecatalog/list-launch-paths.rst
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
Loading