DescribeBudgetActionHistories
Describes a budget action history detail.
Request Syntax
{
"AccountId": "string",
"ActionId": "string",
"BudgetName": "string",
"MaxResults": number,
"NextToken": "string",
"TimePeriod": {
"End": number,
"Start": number
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccountId
-
The account ID of the user. It's a 12-digit number.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12}Required: Yes
- ActionId
-
A system-generated universally unique identifier (UUID) for the action.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$Required: Yes
- BudgetName
-
A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^(?![^:\\]*/action/)[^:\\]+$Required: Yes
- MaxResults
-
An integer that represents how many entries a paginated response contains. The maximum is 100.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A generic string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2147483647.
Pattern:
.*Required: No
- TimePeriod
-
The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.
Type: TimePeriod object
Required: No
Response Syntax
{
"ActionHistories": [
{
"ActionHistoryDetails": {
"Action": {
"ActionId": "string",
"ActionThreshold": {
"ActionThresholdType": "string",
"ActionThresholdValue": number
},
"ActionType": "string",
"ApprovalModel": "string",
"BudgetName": "string",
"Definition": {
"IamActionDefinition": {
"Groups": [ "string" ],
"PolicyArn": "string",
"Roles": [ "string" ],
"Users": [ "string" ]
},
"ScpActionDefinition": {
"PolicyId": "string",
"TargetIds": [ "string" ]
},
"SsmActionDefinition": {
"ActionSubType": "string",
"InstanceIds": [ "string" ],
"Region": "string"
}
},
"ExecutionRoleArn": "string",
"NotificationType": "string",
"Status": "string",
"Subscribers": [
{
"Address": "string",
"SubscriptionType": "string"
}
]
},
"Message": "string"
},
"EventType": "string",
"Status": "string",
"Timestamp": number
}
],
"NextToken": "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.
- ActionHistories
-
The historical record of the budget action resource.
Type: Array of ActionHistory objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- NextToken
-
A generic string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2147483647.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to use this operation with the given parameters.
HTTP Status Code: 400
- InternalErrorException
-
An error on the server occurred during the processing of your request. Try again later.
HTTP Status Code: 400
- InvalidNextTokenException
-
The pagination token is invalid.
HTTP Status Code: 400
- InvalidParameterException
-
An error on the client occurred. Typically, the cause is an invalid input value.
HTTP Status Code: 400
- NotFoundException
-
We can’t locate the resource that you specified.
HTTP Status Code: 400
- ThrottlingException
-
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
