Skip to content

Update Budget Action

budgets_update_budget_action R Documentation

Updates a budget action

Description

Updates a budget action.

Usage

budgets_update_budget_action(AccountId, BudgetName, ActionId,
  NotificationType, ActionThreshold, Definition, ExecutionRoleArn,
  ApprovalModel, Subscribers)

Arguments

AccountId

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

BudgetName

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

Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected.

ActionId

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

NotificationType

The type of a notification. It must be ACTUAL or FORECASTED.

ActionThreshold

The trigger threshold of the action.

Definition

Specifies all of the type-specific parameters.

ExecutionRoleArn

The role passed for action execution and reversion. Roles and actions must be in the same account.

ApprovalModel

This specifies if the action needs manual or automatic approval.

Subscribers

A list of subscribers.

Value

A list with the following syntax:

list(
  AccountId = "string",
  BudgetName = "string",
  OldAction = list(
    ActionId = "string",
    BudgetName = "string",
    NotificationType = "ACTUAL"|"FORECASTED",
    ActionType = "APPLY_IAM_POLICY"|"APPLY_SCP_POLICY"|"RUN_SSM_DOCUMENTS",
    ActionThreshold = list(
      ActionThresholdValue = 123.0,
      ActionThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE"
    ),
    Definition = list(
      IamActionDefinition = list(
        PolicyArn = "string",
        Roles = list(
          "string"
        ),
        Groups = list(
          "string"
        ),
        Users = list(
          "string"
        )
      ),
      ScpActionDefinition = list(
        PolicyId = "string",
        TargetIds = list(
          "string"
        )
      ),
      SsmActionDefinition = list(
        ActionSubType = "STOP_EC2_INSTANCES"|"STOP_RDS_INSTANCES",
        Region = "string",
        InstanceIds = list(
          "string"
        )
      )
    ),
    ExecutionRoleArn = "string",
    ApprovalModel = "AUTOMATIC"|"MANUAL",
    Status = "STANDBY"|"PENDING"|"EXECUTION_IN_PROGRESS"|"EXECUTION_SUCCESS"|"EXECUTION_FAILURE"|"REVERSE_IN_PROGRESS"|"REVERSE_SUCCESS"|"REVERSE_FAILURE"|"RESET_IN_PROGRESS"|"RESET_FAILURE",
    Subscribers = list(
      list(
        SubscriptionType = "SNS"|"EMAIL",
        Address = "string"
      )
    )
  ),
  NewAction = list(
    ActionId = "string",
    BudgetName = "string",
    NotificationType = "ACTUAL"|"FORECASTED",
    ActionType = "APPLY_IAM_POLICY"|"APPLY_SCP_POLICY"|"RUN_SSM_DOCUMENTS",
    ActionThreshold = list(
      ActionThresholdValue = 123.0,
      ActionThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE"
    ),
    Definition = list(
      IamActionDefinition = list(
        PolicyArn = "string",
        Roles = list(
          "string"
        ),
        Groups = list(
          "string"
        ),
        Users = list(
          "string"
        )
      ),
      ScpActionDefinition = list(
        PolicyId = "string",
        TargetIds = list(
          "string"
        )
      ),
      SsmActionDefinition = list(
        ActionSubType = "STOP_EC2_INSTANCES"|"STOP_RDS_INSTANCES",
        Region = "string",
        InstanceIds = list(
          "string"
        )
      )
    ),
    ExecutionRoleArn = "string",
    ApprovalModel = "AUTOMATIC"|"MANUAL",
    Status = "STANDBY"|"PENDING"|"EXECUTION_IN_PROGRESS"|"EXECUTION_SUCCESS"|"EXECUTION_FAILURE"|"REVERSE_IN_PROGRESS"|"REVERSE_SUCCESS"|"REVERSE_FAILURE"|"RESET_IN_PROGRESS"|"RESET_FAILURE",
    Subscribers = list(
      list(
        SubscriptionType = "SNS"|"EMAIL",
        Address = "string"
      )
    )
  )
)

Request syntax

svc$update_budget_action(
  AccountId = "string",
  BudgetName = "string",
  ActionId = "string",
  NotificationType = "ACTUAL"|"FORECASTED",
  ActionThreshold = list(
    ActionThresholdValue = 123.0,
    ActionThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE"
  ),
  Definition = list(
    IamActionDefinition = list(
      PolicyArn = "string",
      Roles = list(
        "string"
      ),
      Groups = list(
        "string"
      ),
      Users = list(
        "string"
      )
    ),
    ScpActionDefinition = list(
      PolicyId = "string",
      TargetIds = list(
        "string"
      )
    ),
    SsmActionDefinition = list(
      ActionSubType = "STOP_EC2_INSTANCES"|"STOP_RDS_INSTANCES",
      Region = "string",
      InstanceIds = list(
        "string"
      )
    )
  ),
  ExecutionRoleArn = "string",
  ApprovalModel = "AUTOMATIC"|"MANUAL",
  Subscribers = list(
    list(
      SubscriptionType = "SNS"|"EMAIL",
      Address = "string"
    )
  )
)