DescribeProductAsAdmin
Gets information about the specified product. This operation is run with administrator access.
Request Syntax
{
"AcceptLanguage": "string",
"Id": "string",
"Name": "string",
"SourcePortfolioId": "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
- SourcePortfolioId
-
The unique identifier of the shared portfolio that the specified product is associated with.
You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9_\-]*Required: No
Response Syntax
{
"Budgets": [
{
"BudgetName": "string"
}
],
"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"
},
"SourceConnection": {
"ConnectionParameters": {
"CodeStar": {
"ArtifactPath": "string",
"Branch": "string",
"ConnectionArn": "string",
"Repository": "string"
}
},
"LastSync": {
"LastSuccessfulSyncProvisioningArtifactId": "string",
"LastSuccessfulSyncTime": number,
"LastSyncStatus": "string",
"LastSyncStatusMessage": "string",
"LastSyncTime": number
},
"Type": "string"
},
"Status": "string"
},
"ProvisioningArtifactSummaries": [
{
"CreatedTime": number,
"Description": "string",
"Id": "string",
"Name": "string",
"ProvisioningArtifactMetadata": {
"string" : "string"
}
}
],
"TagOptions": [
{
"Active": boolean,
"Id": "string",
"Key": "string",
"Owner": "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.
- Budgets
-
Information about the associated budgets.
Type: Array of BudgetDetail objects
- 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
- 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:
