Skip to content

Commit 14bceaf

Browse files
eodeyemi14eodeyemi14
authored
Merge pull request aws#9957 from eodeyemi14/eodeyemi14/servicecatalog-cli-docs
update servicecatalog cli example docs
1 parent 9d358f3 commit 14bceaf

15 files changed

Lines changed: 460 additions & 0 deletions

‎awscli/examples/servicecatalog/create-constraint.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
**To create a constraints**
2+
3+
The following ``create-constraint`` example creates a constraint. ::
4+
5+
aws servicecatalog create-constraint \
6+
--portfolio-id port-y3fnkesxxxxx \
7+
--product-id prod-cfrfxmraxxxxx \
8+
--type LAUNCH \
9+
--parameters '{"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"}'
10+
11+
Output::
12+
13+
{
14+
"ConstraintDetail": {
15+
"ConstraintId": "cons-7tr6gei4bxxxx",
16+
"Type": "LAUNCH",
17+
"Owner": "123456789012",
18+
"ProductId": "prod-cfrfxmra3xxxx",
19+
"PortfolioId": "port-y3fnkeslpxxxx"
20+
},
21+
"ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
22+
"Status": "CREATING"
23+
}
24+
25+
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*.

‎awscli/examples/servicecatalog/create-provisioned-product-plan.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
**To create a plan**
2+
3+
The following ``create-provisioned-product-plan`` example creates a plan. ::
4+
5+
aws servicecatalog create-provisioned-product-plan \
6+
--plan-name test-plan \
7+
--plan-type CLOUDFORMATION \
8+
--product-id prod-cfrfxmraxxxxx \
9+
--provisioned-product-name test-pp \
10+
--provisioning-artifact-id pa-7wz4cu5cxxxxx
11+
12+
Output::
13+
14+
{
15+
"PlanName": "test-plan",
16+
"PlanId": "plan-cuxae3z6gxxxx",
17+
"ProvisionProductId": "pp-7kh7wbc4xxxxx",
18+
"ProvisionedProductName": "test-pp",
19+
"ProvisioningArtifactId": "pa-7wz4cu5cxxxxx"
20+
}
21+
22+
For more information, see `Creating a launch plan <https://docs.aws.amazon.com/servicecatalog/latest/userguide/launch-plan.html>`__ in the *AWS Service Catalog User Guide*.

‎awscli/examples/servicecatalog/delete-constraint.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**To delete a constraint**
2+
3+
The following ``delete-constraint`` example deletes a constraint. ::
4+
5+
aws servicecatalog delete-constraint \
6+
--id cons-7tr6gei4bxxxx
7+
8+
This command produces no output.
9+
10+
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*.

‎awscli/examples/servicecatalog/delete-provisioned-product-plan.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**To delete a provisioned product plan**
2+
3+
The following ``delete-provisioned-product-plan`` example deletes a provisioned product plan. ::
4+
5+
aws servicecatalog delete-provisioned-product-plan \
6+
--plan-id plan-cuxae3z6gxxxx
7+
8+
This command produces no output.
9+
10+
For more information, see `Creating a launch plan <https://docs.aws.amazon.com/servicecatalog/latest/userguide/launch-plan.html>`__ in the *AWS Service Catalog User Guide*.

‎awscli/examples/servicecatalog/describe-constraint.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
**To describe a constraint**
2+
3+
The following ``describe-constraint`` example describes a constraint. ::
4+
5+
aws servicecatalog describe-constraint \
6+
--id "cons-oqp52evr4bxxxx"
7+
8+
Output::
9+
10+
{
11+
"ConstraintDetail": {
12+
"ConstraintId": "cons-7tr6gei4bxxxx",
13+
"Type": "LAUNCH",
14+
"Owner": "123456789012",
15+
"ProductId": "prod-cfrfxmra3xxxx",
16+
"PortfolioId": "port-y3fnkeslpxxxx"
17+
},
18+
"ConstraintParameters": "{\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}",
19+
"Status": "AVAILABLE"
20+
}
21+
22+
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*.

‎awscli/examples/servicecatalog/describe-portfolio-share-status.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**To describe portfolio share status**
2+
3+
The following ``describe-portfolio-share-status`` example describes portfolio share status. ::
4+
5+
aws servicecatalog describe-portfolio-share-status \
6+
--portfolio-share-token "share-agngcybu4xxxx"
7+
8+
Output::
9+
10+
{
11+
"PortfolioShareToken": "share-agngcybu4xxxx",
12+
"PortfolioId": "port-y3fnkeslxxxxx",
13+
"OrganizationNodeValue": "123456789012",
14+
"Status": "COMPLETED",
15+
"ShareDetails": {
16+
"SuccessfulShares": [
17+
"012345678901"
18+
],
19+
"ShareErrors": []
20+
}
21+
}
22+
23+
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*.

‎awscli/examples/servicecatalog/describe-portfolio-shares.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
**To describe portfolio shares**
2+
3+
The following ``describe-portfolio-shares`` example describes portfolio shares. ::
4+
5+
aws servicecatalog describe-portfolio-shares \
6+
--portfolio-id port-y3fnkeslxxxxx \
7+
--type ACCOUNT
8+
9+
Output::
10+
11+
{
12+
"PortfolioShareDetails": [
13+
{
14+
"PrincipalId": "123456789012",
15+
"Type": "ACCOUNT",
16+
"Accepted": true,
17+
"ShareTagOptions": false,
18+
"SharePrincipals": false
19+
},
20+
{
21+
"PrincipalId": "123456789012",
22+
"Type": "ACCOUNT",
23+
"Accepted": false,
24+
"ShareTagOptions": false,
25+
"SharePrincipals": false
26+
}
27+
]
28+
}
29+
30+
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*.

‎awscli/examples/servicecatalog/describe-product.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
**To describe a product**
2+
3+
The following ``describe-product`` example describes a product. ::
4+
5+
aws servicecatalog describe-product \
6+
--id prod-dybl43puxxxxx
7+
8+
Output::
9+
10+
{
11+
"ProductViewSummary": {
12+
"Id": "prodview-vkvy2kum5xxxx",
13+
"ProductId": "prod-dybl43puxxxxx",
14+
"Name": "ec2-test",
15+
"Owner": "user",
16+
"ShortDescription": "",
17+
"Type": "CLOUD_FORMATION_TEMPLATE",
18+
"Distributor": "",
19+
"HasDefaultPath": false,
20+
"SupportEmail": "",
21+
"SupportDescription": "",
22+
"SupportUrl": ""
23+
},
24+
"ProvisioningArtifacts": [
25+
{
26+
"Id": "pa-j7fs6ybztxxxx",
27+
"Name": "v2",
28+
"Description": "",
29+
"CreatedTime": "2021-07-16T15:20:24-05:00",
30+
"Guidance": "DEFAULT"
31+
},
32+
{
33+
"Id": "pa-s6z7i2nivxxxx",
34+
"Description": "Create EC2 and KMS",
35+
"CreatedTime": "2024-06-13T18:27:54-05:00",
36+
"Guidance": "DEFAULT"
37+
},
38+
{
39+
"Id": "pa-6573v3bloxxxx",
40+
"Name": "v3",
41+
"CreatedTime": "2024-06-13T18:45:14-05:00",
42+
"Guidance": "DEFAULT"
43+
}
44+
],
45+
"Budgets": [],
46+
"LaunchPaths": [
47+
{
48+
"Id": "lpv3-y3fnkeslpxxxx",
49+
"Name": "TestPort"
50+
}
51+
]
52+
}
53+
54+
For more information, see `Managing Products <https://docs.aws.amazon.com/servicecatalog/latest/adminguide/catalogs_products.html>`__ in the *AWS Service Catalog User Guide*.

‎awscli/examples/servicecatalog/describe-provisioned-product-plan.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
**To describe a provisioned product plan**
2+
3+
The following ``describe-provisioned-product-plan`` example describes a provisioned product plan. ::
4+
5+
aws servicecatalog describe-provisioned-product-plan \
6+
--plan-id "plan-g7iwsaf3mxxxx"
7+
8+
Output::
9+
10+
{
11+
"ProvisionedProductPlanDetails": {
12+
"CreatedTime": "2025-11-09T18:09:37.808000-06:00",
13+
"PathId": "lpv3-y3fnkeslpxxxx",
14+
"ProductId": "prod-cfrfxmraxxxxx",
15+
"PlanName": "test-plan",
16+
"PlanId": "plan-g7iwsaf3mxxxx",
17+
"ProvisionProductId": "pp-mkbnbztzxxxxx",
18+
"ProvisionProductName": "test-pp",
19+
"PlanType": "CLOUDFORMATION",
20+
"ProvisioningArtifactId": "pa-7wz4cu5cxxxxx",
21+
"Status": "CREATE_SUCCESS",
22+
"UpdatedTime": "2025-11-09T18:09:46.524000-06:00",
23+
"Tags": []
24+
}
25+
}
26+
27+
For more information, see `Creating a launch plan <https://docs.aws.amazon.com/servicecatalog/latest/userguide/launch-plan.html>`__ in the *AWS Service Catalog User Guide*.

‎awscli/examples/servicecatalog/describe-provisioning-parameters.rst‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
**To describe provisioning parameters**
2+
3+
The following ``describe-provisioning-parameters`` example describes provisioning parameters. ::
4+
5+
aws servicecatalog describe-provisioning-parameters \
6+
--product-id prod-cfrfxmraxxxxx \
7+
--provisioning-artifact-id pa-7wz4cu5cxxxxx \
8+
--path-id lpv3-y3fnkeslpxxxx
9+
10+
Output::
11+
12+
{
13+
"ProvisioningArtifactParameters": [
14+
{
15+
"ParameterKey": "Size",
16+
"ParameterType": "String",
17+
"IsNoEcho": false,
18+
"ParameterConstraints": {
19+
"AllowedValues": []
20+
}
21+
}
22+
],
23+
"ConstraintSummaries": [
24+
{
25+
"Type": "LAUNCH"
26+
}
27+
],
28+
"UsageInstructions": [
29+
{
30+
"Type": "rules",
31+
"Value": "{}"
32+
},
33+
{
34+
"Type": "version",
35+
"Value": "2010-09-09"
36+
},
37+
{
38+
"Type": "launchAsRole",
39+
"Value": "arn:aws:iam::123456789012:role/NewLaunchRole"
40+
},
41+
{
42+
"Type": "tagUpdateOnProvisionedProduct",
43+
"Value": "NOT_ALLOWED"
44+
}
45+
],
46+
"TagOptions": [
47+
{
48+
"Key": "Application Name",
49+
"Values": [
50+
"Testing Tag",
51+
"Testing Tag Options"
52+
]
53+
}
54+
],
55+
"ProvisioningArtifactPreferences": {},
56+
"ProvisioningArtifactOutputs": [
57+
{
58+
"Key": "pa-7wz4cu5cxxxxx",
59+
"Description": ""
60+
}
61+
],
62+
"ProvisioningArtifactOutputKeys": []
63+
}
64+
65+
For more information, see `Launching a product <https://docs.aws.amazon.com/servicecatalog/latest/userguide/enduser-launch.html>`__ in the *AWS Service Catalog User Guide*.

0 commit comments

Comments
 (0)