DescribeProvisionedProduct - AWS Service Catalog

DescribeProvisionedProduct

Gets information about the specified provisioned product.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

Type: String

Length Constraints: Maximum length of 100.

Required: No

Id

The provisioned product identifier. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

Type: String

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

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

Required: No

Name

The name of the provisioned product. You must provide the name or ID, but not both.

If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.

Type: String

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]*

Required: No

Response Syntax

{ "CloudWatchDashboards": [ { "Name": "string" } ], "ProvisionedProductDetail": { "Arn": "string", "CreatedTime": number, "Id": "string", "IdempotencyToken": "string", "LastProvisioningRecordId": "string", "LastRecordId": "string", "LastSuccessfulProvisioningRecordId": "string", "LaunchRoleArn": "string", "Name": "string", "ProductId": "string", "ProvisioningArtifactId": "string", "Status": "string", "StatusMessage": "string", "Type": "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.

CloudWatchDashboards

Any CloudWatch dashboards that were created when provisioning the product.

Type: Array of CloudWatchDashboard objects

ProvisionedProductDetail

Information about the provisioned product.

Type: ProvisionedProductDetail object

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: