Skip to content

Describe Subscribers For Notification

budgets_describe_subscribers_for_notification R Documentation

Lists the subscribers that are associated with a notification

Description

Lists the subscribers that are associated with a notification.

Usage

budgets_describe_subscribers_for_notification(AccountId, BudgetName,
  Notification, MaxResults, NextToken)

Arguments

AccountId

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

BudgetName

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

Notification

[required] The notification whose subscribers you want to list.

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(
  Subscribers = list(
    list(
      SubscriptionType = "SNS"|"EMAIL",
      Address = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_subscribers_for_notification(
  AccountId = "string",
  BudgetName = "string",
  Notification = list(
    NotificationType = "ACTUAL"|"FORECASTED",
    ComparisonOperator = "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO",
    Threshold = 123.0,
    ThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE",
    NotificationState = "OK"|"ALARM"
  ),
  MaxResults = 123,
  NextToken = "string"
)