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
  notification_state: "OK", # accepts OK, ALARM
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

The comparison that is used for this notification.

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
1173
1174
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1167

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

#notification_stateString

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

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
1173
1174
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1167

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

#notification_typeString

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

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
1173
1174
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1167

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

#thresholdFloat

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

Returns:

  • (Float)


1167
1168
1169
1170
1171
1172
1173
1174
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1167

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

#threshold_typeString

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For 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 PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

Returns:

  • (String)


1167
1168
1169
1170
1171
1172
1173
1174
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1167

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