Menu
AWS Service Catalog
Developer Guide

DescribeProductAsAdmin

Gets information about the specified product. This operation is run with administrator access.

Request Syntax

{
   "AcceptLanguage": "string",
   "Id": "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

Required: No

Id

The product identifier.

Type: String

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

Required: Yes

Response Syntax

{
   "ProductViewDetail": { 
      "CreatedTime": number,
      "ProductARN": "string",
      "ProductViewSummary": { 
         "Distributor": "string",
         "HasDefaultPath": boolean,
         "Id": "string",
         "Name": "string",
         "Owner": "string",
         "ProductId": "string",
         "ShortDescription": "string",
         "SupportDescription": "string",
         "SupportEmail": "string",
         "SupportUrl": "string",
         "Type": "string"
      },
      "Status": "string"
   },
   "ProvisioningArtifactSummaries": [ 
      { 
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "ProvisioningArtifactMetadata": { 
            "string" : "string" 
         }
      }
   ],
   "TagOptions": [ 
      { 
         "Active": boolean,
         "Id": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

ProductViewDetail

Information about the product view.

Type: ProductViewDetail object

ProvisioningArtifactSummaries

Information about the provisioning artifacts (also known as versions) for the specified product.

Type: Array of ProvisioningArtifactSummary objects

TagOptions

Information about the TagOptions associated with the product.

Type: Array of TagOptionDetail objects

Tags

Information about the tags associated with the product.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Errors

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: