[ aws . servicecatalog ]
describe-product-as-admin¶
Description¶
Gets information about the specified product. This operation is run with administrator access.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-product-as-admin
[--accept-language <value>]
[--id <value>]
[--name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--accept-language (string)
The language code.
en- English (default)
jp- Japanese
zh- Chinese
--id (string)
The product identifier.
--name (string)
The product name.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To describe a product as an administrator
The following describe-product-as-admin example displays details for the specified product using administrator privileges.
aws servicecatalog describe-product-as-admin \
--id prod-abcdcek6yhbxi
Output:
{
"TagOptions": [],
"ProductViewDetail": {
"ProductARN": "arn:aws:catalog:us-west-2:687558542028:product/prod-abcdcek6yhbxi",
"ProductViewSummary": {
"SupportEmail": "test@amazon.com",
"Type": "CLOUD_FORMATION_TEMPLATE",
"Distributor": "test-distributor",
"ShortDescription": "test-description",
"Owner": "test-owner",
"Id": "prodview-wi3l2j4abc6vc",
"SupportDescription": "test-support",
"ProductId": "prod-abcdcek6yhbxi",
"HasDefaultPath": false,
"Name": "test-product3",
"SupportUrl": "https://aws.amazon.com"
},
"CreatedTime": 1577136715.0,
"Status": "CREATED"
},
"ProvisioningArtifactSummaries": [
{
"CreatedTime": 1577136715.0,
"Description": "test-version-description",
"ProvisioningArtifactMetadata": {
"SourceProvisioningArtifactId": "pa-abcdxkkiv5fcm"
},
"Name": "test-version-name-3",
"Id": "pa-abcdxkkiv5fcm"
}
],
"Tags": [
{
"Value": "iad",
"Key": "region"
}
]
}
Output¶
ProductViewDetail -> (structure)
Information about the product view.
ProductViewSummary -> (structure)
Summary information about the product view.
Id -> (string)
The product view identifier.
ProductId -> (string)
The product identifier.
Name -> (string)
The name of the product.
Owner -> (string)
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription -> (string)
Short description of the product.
Type -> (string)
The product type. Contact the product administrator for the significance of this value. If this value is
MARKETPLACE, the product was created by AWS Marketplace.Distributor -> (string)
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath -> (boolean)
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters .
SupportEmail -> (string)
The email contact information to obtain support for this Product.
SupportDescription -> (string)
The description of the support for this Product.
SupportUrl -> (string)
The URL information to obtain support for this Product.
Status -> (string)
The status of the product.
AVAILABLE- The product is ready for use.
CREATING- Product creation has started; the product is not ready for use.
FAILED- An action failed.ProductARN -> (string)
The ARN of the product.
CreatedTime -> (timestamp)
The UTC time stamp of the creation time.
ProvisioningArtifactSummaries -> (list)
Information about the provisioning artifacts (also known as versions) for the specified product.
(structure)
Summary information about a provisioning artifact (also known as a version) for a product.
Id -> (string)
The identifier of the provisioning artifact.
Name -> (string)
The name of the provisioning artifact.
Description -> (string)
The description of the provisioning artifact.
CreatedTime -> (timestamp)
The UTC time stamp of the creation time.
ProvisioningArtifactMetadata -> (map)
The metadata for the provisioning artifact. This is used with AWS Marketplace products.
key -> (string)
value -> (string)
Tags -> (list)
Information about the tags associated with the product.
(structure)
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key -> (string)
The tag key.
Value -> (string)
The value for this key.
TagOptions -> (list)
Information about the TagOptions associated with the product.
(structure)
Information about a TagOption.
Key -> (string)
The TagOption key.
Value -> (string)
The TagOption value.
Active -> (boolean)
The TagOption active state.
Id -> (string)
The TagOption identifier.
Budgets -> (list)
Information about the associated budgets.
(structure)
Information about a budget.
BudgetName -> (string)
Name of the associated budget.