NAME

Paws::Budgets::Notification

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Budgets::Notification object:

  $service_obj->Method(Att1 => { ComparisonOperator => $value, ..., ThresholdType => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Budgets::Notification object:

  $result = $service_obj->Method(...);
  $result->Att1->ComparisonOperator

DESCRIPTION

A notification that is associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL

  • A thresholdType of PERCENTAGE

  • A comparisonOperator of GREATER_THAN

  • A notification threshold of 80

ATTRIBUTES

REQUIRED ComparisonOperator => Str

  The comparison that is used for this notification.

NotificationState => Str

  Whether this notification is in alarm. If a budget notification is in
the C<ALARM> state, you have passed the set threshold for the budget.

REQUIRED NotificationType => Str

  Whether the notification is for how much you have spent (C<ACTUAL>) or
for how much you're forecasted to spend (C<FORECASTED>).

REQUIRED Threshold => Num

  The threshold that is associated with a notification. Thresholds are
always a percentage.

ThresholdType => Str

  The type of threshold for a notification. For C<ABSOLUTE_VALUE>
thresholds, AWS notifies you when you go over or are forecasted to go
over your total cost threshold. For C<PERCENTAGE> thresholds, AWS
notifies you when you go over or are forecasted to go over a certain
percentage of your forecasted spend. For example, if you have a budget
for 200 dollars and you have a C<PERCENTAGE> threshold of 80%, AWS
notifies you when you go over 160 dollars.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Budgets

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues