DescribeBudgetActionCommand

Suggest an Edit

Describes a budget action detail.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { BudgetsClient, DescribeBudgetActionCommand } from "@aws-sdk/client-budgets"; // ES Modules import
// const { BudgetsClient, DescribeBudgetActionCommand } = require("@aws-sdk/client-budgets"); // CommonJS import
const client = new BudgetsClient(config);
const input = { // DescribeBudgetActionRequest
  AccountId: "STRING_VALUE", // required
  BudgetName: "STRING_VALUE", // required
  ActionId: "STRING_VALUE", // required
};
const command = new DescribeBudgetActionCommand(input);
const response = await client.send(command);
// { // DescribeBudgetActionResponse
//   AccountId: "STRING_VALUE", // required
//   BudgetName: "STRING_VALUE", // required
//   Action: { // Action
//     ActionId: "STRING_VALUE", // required
//     BudgetName: "STRING_VALUE", // required
//     NotificationType: "ACTUAL" || "FORECASTED", // required
//     ActionType: "APPLY_IAM_POLICY" || "APPLY_SCP_POLICY" || "RUN_SSM_DOCUMENTS", // required
//     ActionThreshold: { // ActionThreshold
//       ActionThresholdValue: Number("double"), // required
//       ActionThresholdType: "PERCENTAGE" || "ABSOLUTE_VALUE", // required
//     },
//     Definition: { // Definition
//       IamActionDefinition: { // IamActionDefinition
//         PolicyArn: "STRING_VALUE", // required
//         Roles: [ // Roles
//           "STRING_VALUE",
//         ],
//         Groups: [ // Groups
//           "STRING_VALUE",
//         ],
//         Users: [ // Users
//           "STRING_VALUE",
//         ],
//       },
//       ScpActionDefinition: { // ScpActionDefinition
//         PolicyId: "STRING_VALUE", // required
//         TargetIds: [ // TargetIds // required
//           "STRING_VALUE",
//         ],
//       },
//       SsmActionDefinition: { // SsmActionDefinition
//         ActionSubType: "STOP_EC2_INSTANCES" || "STOP_RDS_INSTANCES", // required
//         Region: "STRING_VALUE", // required
//         InstanceIds: [ // InstanceIds // required
//           "STRING_VALUE",
//         ],
//       },
//     },
//     ExecutionRoleArn: "STRING_VALUE", // required
//     ApprovalModel: "AUTOMATIC" || "MANUAL", // required
//     Status: "STANDBY" || "PENDING" || "EXECUTION_IN_PROGRESS" || "EXECUTION_SUCCESS" || "EXECUTION_FAILURE" || "REVERSE_IN_PROGRESS" || "REVERSE_SUCCESS" || "REVERSE_FAILURE" || "RESET_IN_PROGRESS" || "RESET_FAILURE", // required
//     Subscribers: [ // Subscribers // required
//       { // Subscriber
//         SubscriptionType: "SNS" || "EMAIL", // required
//         Address: "STRING_VALUE", // required
//       },
//     ],
//   },
// };

DescribeBudgetActionCommand Input

See DescribeBudgetActionCommandInput for more details

Parameter
Type
Description
AccountId
Required
string | undefined

The account ID of the user. It's a 12-digit number.

ActionId
Required
string | undefined

A system-generated universally unique identifier (UUID) for the action.

BudgetName
Required
string | undefined

A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.

DescribeBudgetActionCommand Output

See DescribeBudgetActionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AccountId
Required
string | undefined

The account ID of the user. It's a 12-digit number.

Action
Required
Action | undefined

A budget action resource.

BudgetName
Required
string | undefined

A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.

Throws

Name
Fault
Details
AccessDeniedException
client

You are not authorized to use this operation with the given parameters.

InternalErrorException
server

An error on the server occurred during the processing of your request. Try again later.

InvalidParameterException
client

An error on the client occurred. Typically, the cause is an invalid input value.

NotFoundException
client

We can’t locate the resource that you specified.

ThrottlingException
client

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

BudgetsServiceException
Base exception class for all service exceptions from Budgets service.