[ aws . budgets ]

create-subscriber

Description

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-subscriber
--account-id <value>
--budget-name <value>
--notification <value>
--subscriber <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The accountId that is associated with the budget that you want to create a subscriber for.

--budget-name (string)

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

--notification (structure)

The notification that you want to create a subscriber for.

Shorthand Syntax:

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

JSON Syntax:

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

--subscriber (structure)

The subscriber that you want to associate with a budget notification.

Shorthand Syntax:

SubscriptionType=string,Address=string

JSON Syntax:

{
  "SubscriptionType": "SNS"|"EMAIL",
  "Address": "string"
}

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--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.

Examples

To create a subscriber for a notification associated with a Cost and Usage budget

This example creates a subscriber for the specified notification.

Command:

aws budgets create-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com

Output