UpdateBudgetAction
Updates a budget action.
Request Syntax
{
"AccountId": "string",
"ActionId": "string",
"ActionThreshold": {
"ActionThresholdType": "string",
"ActionThresholdValue": number
},
"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",
"Subscribers": [
{
"Address": "string",
"SubscriptionType": "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
- ActionThreshold
-
The trigger threshold of the action.
Type: ActionThreshold object
Required: No
- ApprovalModel
-
This specifies if the action needs manual or automatic approval.
Type: String
Valid Values:
AUTOMATIC | MANUALRequired: No
- 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
- Definition
-
Specifies all of the type-specific parameters.
Type: Definition object
Required: No
- ExecutionRoleArn
-
The role passed for action execution and reversion. Roles and actions must be in the same account.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 618.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|us-iso-east-1|us-isob-east-1):iam::\d{12}:role(\u002F[\u0021-\u007F]+\u002F|\u002F)[\w+=,.@-]+$Required: No
- NotificationType
-
The type of a notification. It must be ACTUAL or FORECASTED.
Type: String
Valid Values:
ACTUAL | FORECASTEDRequired: No
- Subscribers
-
A list of subscribers.
Type: Array of Subscriber objects
Array Members: Minimum number of 1 item. Maximum number of 11 items.
Required: No
Response Syntax
{
"AccountId": "string",
"BudgetName": "string",
"NewAction": {
"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"
}
]
},
"OldAction": {
"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"
}
]
}
}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} - 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>.*)[^:\\]+$ - NewAction
-
The updated action resource information.
Type: Action object
- OldAction
-
The previous action resource information.
Type: Action object
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
- 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
- ResourceLockedException
-
The request was received and recognized by the server, but the server rejected that particular method for the requested resource.
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:
