ExecuteBudgetAction
Executes a budget action.
Request Syntax
{
"AccountId": "string",
"ActionId": "string",
"BudgetName": "string",
"ExecutionType": "string"
}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/|(?i).*<script>.*</script>.*)[^:\\]+$Required: Yes
- ExecutionType
-
The type of execution.
Type: String
Valid Values:
APPROVE_BUDGET_ACTION | RETRY_BUDGET_ACTION | REVERSE_BUDGET_ACTION | RESET_BUDGET_ACTIONRequired: Yes
Response Syntax
{
"AccountId": "string",
"ActionId": "string",
"BudgetName": "string",
"ExecutionType": "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.
- AccountId
-
The account ID of the user. It's a 12-digit number.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
\d{12} - 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}$ - 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/|(?i).*<script>.*</script>.*)[^:\\]+$ - ExecutionType
-
The type of execution.
Type: String
Valid Values:
APPROVE_BUDGET_ACTION | RETRY_BUDGET_ACTION | REVERSE_BUDGET_ACTION | RESET_BUDGET_ACTION
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.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
- InternalErrorException
-
An error on the server occurred during the processing of your request. Try again later.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
- InvalidParameterException
-
An error on the client occurred. Typically, the cause is an invalid input value.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
- NotFoundException
-
We can’t locate the resource that you specified.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
- ResourceLockedException
-
The request was received and recognized by the server, but the server rejected that particular method for the requested resource.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
- ThrottlingException
-
The number of API requests has exceeded the maximum allowed API request throttling limit for the account.
- Message
-
The error message the exception carries.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: