ServiceCatalog / Client / describe_product

describe_product

ServiceCatalog.Client.describe_product(**kwargs)

Gets information about the specified product.

Note

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

See also: AWS API Documentation

Request Syntax

response = client.describe_product(
    AcceptLanguage='string',
    Id='string',
    Name='string'
)

Parameters:

• AcceptLanguage (string) –

  The language code.

  • jp - Japanese

  • zh - Chinese

• Id (string) – The product identifier.

• Name (string) – The product name.

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'
        },
    ],
    'Budgets': [
        {
            'BudgetName': 'string'
        },
    ],
    'LaunchPaths': [
        {
            'Id': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • ProductViewSummary (dict) –

    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 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 specified 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.

  • Budgets (list) –

    Information about the associated budgets.

    • (dict) –

      Information about a budget.

      • BudgetName (string) –

        Name of the associated budget.

  • LaunchPaths (list) –

    Information about the associated launch paths.

    • (dict) –

      A launch path object.

      • Id (string) –

        The identifier of the launch path.

      • Name (string) –

        The name of the launch path.

Exceptions

• ServiceCatalog.Client.exceptions.ResourceNotFoundException

• ServiceCatalog.Client.exceptions.InvalidParametersException