Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . budgets ]

describe-subscribers-for-notification

Description

Lists the subscribers associated with a notification.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-subscribers-for-notification
--account-id <value>
--budget-name <value>
--notification <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

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

--budget-name (string)

The name of the budget whose subscribers you want descriptions of.

--notification (structure)

The notification whose subscribers you want to list.

Shorthand Syntax:

NotificationType=string,ComparisonOperator=string,Threshold=double,ThresholdType=string

JSON Syntax:

{
  "NotificationType": "ACTUAL"|"FORECASTED",
  "ComparisonOperator": "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO",
  "Threshold": double,
  "ThresholdType": "PERCENTAGE"|"ABSOLUTE_VALUE"
}

--max-results (integer)

Optional integer. Specifies the maximum number of results to return in response.

--next-token (string)

The pagination token that indicates the next set of results to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Subscribers -> (list)

A list of subscribers associated with a notification.

(structure)

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple notification Service topic or an email address.

For example, an email subscriber would have the following parameters:

  • A subscriptionType of EMAIL
  • An address of example@example.com

SubscriptionType -> (string)

The type of notification that AWS sends to a subscriber.

Address -> (string)

The address that AWS sends budget notifications to, either an SNS topic or an email.

NextToken -> (string)

The pagination token that indicates the next set of results that you can retrieve.