DescribeProvisionedProductPlan
Gets information about the resource changes for the specified plan.
Request Syntax
{
"AcceptLanguage": "string
",
"PageSize": number
,
"PageToken": "string
",
"PlanId": "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
-
- 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
- PlanId
-
The plan identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9_\-]*
Required: Yes
Response Syntax
{
"NextPageToken": "string",
"ProvisionedProductPlanDetails": {
"CreatedTime": number,
"NotificationArns": [ "string" ],
"PathId": "string",
"PlanId": "string",
"PlanName": "string",
"PlanType": "string",
"ProductId": "string",
"ProvisioningArtifactId": "string",
"ProvisioningParameters": [
{
"Key": "string",
"UsePreviousValue": boolean,
"Value": "string"
}
],
"ProvisionProductId": "string",
"ProvisionProductName": "string",
"Status": "string",
"StatusMessage": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"UpdatedTime": number
},
"ResourceChanges": [
{
"Action": "string",
"Details": [
{
"CausingEntity": "string",
"Evaluation": "string",
"Target": {
"Attribute": "string",
"Name": "string",
"RequiresRecreation": "string"
}
}
],
"LogicalResourceId": "string",
"PhysicalResourceId": "string",
"Replacement": "string",
"ResourceType": "string",
"Scope": [ "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]*
- ProvisionedProductPlanDetails
-
Information about the plan.
Type: ProvisionedProductPlanDetails object
- ResourceChanges
-
Information about the resource changes that will occur when the plan is executed.
Type: Array of ResourceChange 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: