ServiceCatalog / Client / describe_product_view
describe_product_view#
- ServiceCatalog.Client.describe_product_view(**kwargs)#
Gets information about the specified product.
See also: AWS API Documentation
Request Syntax
response = client.describe_product_view( AcceptLanguage='string', Id='string' )
- Parameters:
AcceptLanguage (string) –
The language code.
jp
- Japanesezh
- Chinese
Id (string) –
[REQUIRED]
The product view identifier.
- Return type:
dict
- Returns:
Response Syntax
{ 'ProductViewSummary': { 'Id': 'string', 'ProductId': 'string', 'Name': 'string', 'Owner': 'string', 'ShortDescription': 'string', 'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD'|'EXTERNAL', 'Distributor': 'string', 'HasDefaultPath': True|False, 'SupportEmail': 'string', 'SupportDescription': 'string', 'SupportUrl': 'string' }, 'ProvisioningArtifacts': [ { 'Id': 'string', 'Name': 'string', 'Description': 'string', 'CreatedTime': datetime(2015, 1, 1), 'Guidance': 'DEFAULT'|'DEPRECATED' }, ] }
Response Structure
(dict) –
ProductViewSummary (dict) –
Summary information about the product.
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 Amazon Web Services 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.
ProvisioningArtifacts (list) –
Information about the provisioning artifacts for the product.
(dict) –
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
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 (datetime) –
The UTC time stamp of the creation time.
Guidance (string) –
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Exceptions
ServiceCatalog.Client.exceptions.ResourceNotFoundException
ServiceCatalog.Client.exceptions.InvalidParametersException