You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Budgets::Types::Notification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass Notification data as a hash:

{
  notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
  comparison_operator: "GREATER_THAN", # required, accepts GREATER_THAN, LESS_THAN, EQUAL_TO
  threshold: 1.0, # required
  threshold_type: "PERCENTAGE", # accepts PERCENTAGE, ABSOLUTE_VALUE
}

A notification 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 ten 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 comparisonOperator of GREATER_THAN

  • A notification threshold of 80

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

The comparison used for this notification.

Returns:

  • (String)


839
840
841
842
843
844
845
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 839

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#notification_typeString

Whether the notification is for how much you have spent (ACTUAL) or for how much you are forecasted to spend (FORECASTED).

Returns:

  • (String)


839
840
841
842
843
844
845
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 839

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#thresholdFloat

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

Returns:

  • (Float)


839
840
841
842
843
844
845
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 839

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end

#threshold_typeString

The type of threshold for a notification. For ACTUAL thresholds, AWS notifies you when you go over the threshold, and for FORECASTED thresholds AWS notifies you when you are forecasted to go over the threshold.

Returns:

  • (String)


839
840
841
842
843
844
845
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 839

class Notification < Struct.new(
  :notification_type,
  :comparison_operator,
  :threshold,
  :threshold_type)
  include Aws::Structure
end