AWS cli documentation change
Summary
Added examples section demonstrating product description with CLI command and output format
Security assessment
The change adds product description examples showing output structure. No security issues are mentioned, and the content focuses on general product metadata without security features.
Diff
diff --git a/cli/latest/reference/servicecatalog/describe-product.md b/cli/latest/reference/servicecatalog/describe-product.md index 2e83704e1..04829f974 100644 --- a//cli/latest/reference/servicecatalog/describe-product.md +++ b//cli/latest/reference/servicecatalog/describe-product.md @@ -15 +15 @@ - * [AWS CLI 2.35.13 Command Reference](../../index.html) » + * [AWS CLI 2.35.15 Command Reference](../../index.html) » @@ -35,0 +36 @@ + * Examples @@ -246,0 +248,67 @@ The formatting style for error output. By default, errors are displayed in enhan +## Examples¶ + +### Note + +To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the _AWS CLI User Guide_ for more information. + +Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the _AWS CLI User Guide_ . + +**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_. + @@ -473 +541 @@ LaunchPaths -> (list) - * [AWS CLI 2.35.13 Command Reference](../../index.html) » + * [AWS CLI 2.35.15 Command Reference](../../index.html) »