DescribeRecord
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).
Note
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.
Request Syntax
{
"AcceptLanguage": "string",
"Id": "string",
"PageSize": number,
"PageToken": "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 record identifier of the provisioned product. This identifier is returned by the request operation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9_\-]*Required: Yes
- PageSize
-
The maximum number of items to return with this call.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 20.
Required: No
- PageToken
-
The page token for the next set of results. To retrieve the first set of results, use null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]*Required: No
Response Syntax
{
"NextPageToken": "string",
"RecordDetail": {
"CreatedTime": number,
"LaunchRoleArn": "string",
"PathId": "string",
"ProductId": "string",
"ProvisionedProductId": "string",
"ProvisionedProductName": "string",
"ProvisionedProductType": "string",
"ProvisioningArtifactId": "string",
"RecordErrors": [
{
"Code": "string",
"Description": "string"
}
],
"RecordId": "string",
"RecordTags": [
{
"Key": "string",
"Value": "string"
}
],
"RecordType": "string",
"Status": "string",
"UpdatedTime": number
},
"RecordOutputs": [
{
"Description": "string",
"OutputKey": "string",
"OutputValue": "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.
- NextPageToken
-
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
Type: String
Length Constraints: Maximum length of 2024.
Pattern:
[\u0009\u000a\u000d\u0020-\uD7FF\uE000-\uFFFD]* - RecordDetail
-
Information about the product.
Type: RecordDetail object
- RecordOutputs
-
Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
Type: Array of RecordOutput objects
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:
