Skip to content

Describe Budget Action Histories

budgets_describe_budget_action_histories R Documentation

Describes a budget action history detail

Description

Describes a budget action history detail.

Usage

budgets_describe_budget_action_histories(AccountId, BudgetName,
  ActionId, TimePeriod, MaxResults, NextToken)

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.

TimePeriod

The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

MaxResults

An integer that represents how many entries a paginated response contains. The maximum is 100.

NextToken

A generic string.

Value

A list with the following syntax:

list(
  ActionHistories = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      Status = "STANDBY"|"PENDING"|"EXECUTION_IN_PROGRESS"|"EXECUTION_SUCCESS"|"EXECUTION_FAILURE"|"REVERSE_IN_PROGRESS"|"REVERSE_SUCCESS"|"REVERSE_FAILURE"|"RESET_IN_PROGRESS"|"RESET_FAILURE",
      EventType = "SYSTEM"|"CREATE_ACTION"|"DELETE_ACTION"|"UPDATE_ACTION"|"EXECUTE_ACTION",
      ActionHistoryDetails = list(
        Message = "string",
        Action = 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"
            )
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_budget_action_histories(
  AccountId = "string",
  BudgetName = "string",
  ActionId = "string",
  TimePeriod = list(
    Start = as.POSIXct(
      "2015-01-01"
    ),
    End = as.POSIXct(
      "2015-01-01"
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)