Describe Budget Performance History

budgets_describe_budget_performance_history

R Documentation

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets

Description

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

Usage

budgets_describe_budget_performance_history(AccountId, BudgetName,
  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.
TimePeriod	Retrieves how often the budget went into an ALARM state for the specified time period.
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(
  BudgetPerformanceHistory = list(
    BudgetName = "string",
    BudgetType = "USAGE"|"COST"|"RI_UTILIZATION"|"RI_COVERAGE"|"SAVINGS_PLANS_UTILIZATION"|"SAVINGS_PLANS_COVERAGE",
    CostFilters = list(
      list(
        "string"
      )
    ),
    CostTypes = list(
      IncludeTax = TRUE|FALSE,
      IncludeSubscription = TRUE|FALSE,
      UseBlended = TRUE|FALSE,
      IncludeRefund = TRUE|FALSE,
      IncludeCredit = TRUE|FALSE,
      IncludeUpfront = TRUE|FALSE,
      IncludeRecurring = TRUE|FALSE,
      IncludeOtherSubscription = TRUE|FALSE,
      IncludeSupport = TRUE|FALSE,
      IncludeDiscount = TRUE|FALSE,
      UseAmortized = TRUE|FALSE
    ),
    TimeUnit = "DAILY"|"MONTHLY"|"QUARTERLY"|"ANNUALLY"|"CUSTOM",
    BillingViewArn = "string",
    BudgetedAndActualAmountsList = list(
      list(
        BudgetedAmount = list(
          Amount = "string",
          Unit = "string"
        ),
        ActualAmount = list(
          Amount = "string",
          Unit = "string"
        ),
        TimePeriod = list(
          Start = as.POSIXct(
            "2015-01-01"
          ),
          End = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    ),
    FilterExpression = list(
      Or = list(
        list()
      ),
      And = list(
        list()
      ),
      Not = list(),
      Dimensions = list(
        Key = "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"INVOICING_ENTITY"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"RESERVATION_MODIFIED"|"TAG_KEY"|"COST_CATEGORY_NAME",
        Values = list(
          "string"
        ),
        MatchOptions = list(
          "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"
        )
      ),
      Tags = list(
        Key = "string",
        Values = list(
          "string"
        ),
        MatchOptions = list(
          "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"
        )
      ),
      CostCategories = list(
        Key = "string",
        Values = list(
          "string"
        ),
        MatchOptions = list(
          "EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"GREATER_THAN_OR_EQUAL"|"CASE_SENSITIVE"|"CASE_INSENSITIVE"
        )
      )
    ),
    Metrics = list(
      "BlendedCost"|"UnblendedCost"|"AmortizedCost"|"NetUnblendedCost"|"NetAmortizedCost"|"UsageQuantity"|"NormalizedUsageAmount"|"Hours"
    )
  ),
  NextToken = "string"
)

Request syntax

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