budgets_describe_budgets: Lists the budgets that are associated with an account

Description Usage Arguments Value Request syntax

View source: R/budgets_operations.R

Description

Lists the budgets that are associated with an account.

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

Usage

1
budgets_describe_budgets(AccountId, MaxResults, NextToken)

Arguments

AccountId

[required] The accountId that is associated with the budgets that you want descriptions of.

MaxResults

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

NextToken

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
list(
  Budgets = list(
    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",
      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"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
svc$describe_budgets(
  AccountId = "string",
  MaxResults = 123,
  NextToken = "string"
)

paws.cost.management documentation built on Aug. 23, 2021, 9:20 a.m.