Skip to content

Retrieves billing preferences for the specified feature

Description

Retrieves billing preferences for the specified feature. Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, and per-credit options.

Usage

billing_get_billing_preferences(nextToken, maxResults, features,
  filters)

Arguments

  • nextToken

Pagination token from a previous response. Pass the value returned in nextToken to retrieve the next page of results.

  • maxResults

The maximum number of records to return per page. Range: 1 to 50. Default: 50.

  • features

[required] The feature to retrieve. Specify exactly one value. Valid values: BILLING_ALERTS, RI_SHARING, RI_SHARING_HISTORY, CREDIT_SHARING, CREDIT_SHARING_HISTORY, CREDIT_LEVEL_SHARING, CREDIT_PREFERENCE_OPTIONS.

  • filters

Filters to narrow results. Specify exactly one filter when supplied. The supported filter name is PREFERENCE_KEY, which accepts 1 to 10 values to match preference keys.

Value

A list with the following syntax:

list(
  billingPreferences = list(
    list(
      feature = "RI_SHARING"|"RI_SHARING_HISTORY"|"CREDIT_SHARING"|"CREDIT_SHARING_HISTORY"|"CREDIT_LEVEL_SHARING"|"BILLING_ALERTS"|"CREDIT_PREFERENCE_OPTIONS",
      key = "string",
      value = "ENABLED"|"DISABLED",
      accountName = "string",
      accountId = "string",
      billingPeriod = list(
        year = 123,
        month = 123
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$get_billing_preferences(
  nextToken = "string",
  maxResults = 123,
  features = list(
    "RI_SHARING"|"RI_SHARING_HISTORY"|"CREDIT_SHARING"|"CREDIT_SHARING_HISTORY"|"CREDIT_LEVEL_SHARING"|"BILLING_ALERTS"|"CREDIT_PREFERENCE_OPTIONS"
  ),
  filters = list(
    list(
      name = "PREFERENCE_KEY",
      value = list(
        "string"
      )
    )
  )
)