Skip to content

Describe Notifications For Budget

budgets_describe_notifications_for_budget R Documentation

Lists the notifications that are associated with a budget

Description

Lists the notifications that are associated with a budget.

Usage

budgets_describe_notifications_for_budget(AccountId, BudgetName,
  MaxResults, NextToken)

Arguments

AccountId

[required] The accountId that is associated with the budget whose notifications you want descriptions of.

BudgetName

[required] The name of the budget whose notifications you want descriptions of.

MaxResults

An optional integer that represents how many entries a paginated response contains.

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:

list(
  Notifications = list(
    list(
      NotificationType = "ACTUAL"|"FORECASTED",
      ComparisonOperator = "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO",
      Threshold = 123.0,
      ThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE",
      NotificationState = "OK"|"ALARM"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_notifications_for_budget(
  AccountId = "string",
  BudgetName = "string",
  MaxResults = 123,
  NextToken = "string"
)