DescribeProduct - AWS Service Catalog

DescribeProduct

Gets information about the specified product.

Note

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

Request Syntax

{ "AcceptLanguage": "string", "Id": "string", "Name": "string" }

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

Id

The product identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_\-]*

Required: No

Name

The product name.

Type: String

Length Constraints: Maximum length of 8191.

Required: No

Response Syntax

{ "Budgets": [ { "BudgetName": "string" } ], "LaunchPaths": [ { "Id": "string", "Name": "string" } ], "ProductViewSummary": { "Distributor": "string", "HasDefaultPath": boolean, "Id": "string", "Name": "string", "Owner": "string", "ProductId": "string", "ShortDescription": "string", "SupportDescription": "string", "SupportEmail": "string", "SupportUrl": "string", "Type": "string" }, "ProvisioningArtifacts": [ { "CreatedTime": number, "Description": "string", "Guidance": "string", "Id": "string", "Name": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Budgets

Information about the associated budgets.

Type: Array of BudgetDetail objects

LaunchPaths

Information about the associated launch paths.

Type: Array of LaunchPath objects

ProductViewSummary

Summary information about the product view.

Type: ProductViewSummary object

ProvisioningArtifacts

Information about the provisioning artifacts for the specified product.

Type: Array of ProvisioningArtifact objects

Errors

InvalidParametersException

One or more parameters provided to the operation are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: