Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeBudgetActionsForAccount

Describes all of the budget actions for an account.

Request Syntax


{
   "AccountId": "string",
   "MaxResults": number,
   "NextToken": "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

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

Response Syntax


{
   "Actions": [ 
      { 
         "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"
            }
         ]
      }
   ],
   "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.

Actions

A list of the budget action resources information.

Type: Array of Action 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

ThrottlingException

The number of API requests has exceeded the maximum allowed API request throttling limit for the account.

HTTP Status Code: 400