Describes a budget¶

Description¶

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Usage¶

budgets_describe_budget(AccountId, BudgetName, ShowFilterExpression)

Arguments¶

AccountId

[required] The accountId that is associated with the budget that you want a description of.
BudgetName

[required] The name of the budget that you want a description of.
ShowFilterExpression

Specifies whether the response includes the filter expression associated with the budget. By showing the filter expression, you can see detailed filtering logic applied to the budget, such as Amazon Web Services services or tags that are being tracked.

Value¶

A list with the following syntax:

list(
  Budget = list(
    BudgetName = "string",
    BudgetLimit = list(
      Amount = "string",
      Unit = "string"
    ),
    PlannedBudgetLimits = list(
      list(
        Amount = "string",
        Unit = "string"
      )
    ),
    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",
    TimePeriod = list(
      Start = as.POSIXct(
        "2015-01-01"
      ),
      End = as.POSIXct(
        "2015-01-01"
      )
    ),
    CalculatedSpend = list(
      ActualSpend = list(
        Amount = "string",
        Unit = "string"
      ),
      ForecastedSpend = list(
        Amount = "string",
        Unit = "string"
      )
    ),
    BudgetType = "USAGE"|"COST"|"RI_UTILIZATION"|"RI_COVERAGE"|"SAVINGS_PLANS_UTILIZATION"|"SAVINGS_PLANS_COVERAGE",
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    AutoAdjustData = list(
      AutoAdjustType = "HISTORICAL"|"FORECAST",
      HistoricalOptions = list(
        BudgetAdjustmentPeriod = 123,
        LookBackAvailablePeriods = 123
      ),
      LastAutoAdjustTime = 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"
    ),
    BillingViewArn = "string",
    HealthStatus = list(
      Status = "HEALTHY"|"UNHEALTHY",
      StatusReason = "BILLING_VIEW_NO_ACCESS"|"BILLING_VIEW_UNHEALTHY"|"FILTER_INVALID"|"MULTI_YEAR_HISTORICAL_DATA_DISABLED",
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$describe_budget(
  AccountId = "string",
  BudgetName = "string",
  ShowFilterExpression = TRUE|FALSE
)