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

Class: Aws::Budgets::Types::DescribeSubscribersForNotificationRequest

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 DescribeSubscribersForNotificationRequest data as a hash:

{
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  notification: { # required
    notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
    comparison_operator: "GREATER_THAN", # required, accepts GREATER_THAN, LESS_THAN, EQUAL_TO
    threshold: 1.0, # required
  },
  max_results: 1,
  next_token: "GenericString",
}

Request of DescribeSubscribersForNotification

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

Account Id of the customer. It should be a 12 digit number.

Returns:

  • (String)


631
632
633
634
635
636
637
638
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 631

class DescribeSubscribersForNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :max_results,
  :next_token)
  include Aws::Structure
end

#budget_nameString

A string represents the budget name. No ":" and "\" character is allowed.

Returns:

  • (String)


631
632
633
634
635
636
637
638
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 631

class DescribeSubscribersForNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.

Returns:

  • (Integer)


631
632
633
634
635
636
637
638
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 631

class DescribeSubscribersForNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

A generic String.

Returns:

  • (String)


631
632
633
634
635
636
637
638
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 631

class DescribeSubscribersForNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :max_results,
  :next_token)
  include Aws::Structure
end

#notificationTypes::Notification

Notification model. Each budget may contain multiple notifications with different settings.

Returns:



631
632
633
634
635
636
637
638
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 631

class DescribeSubscribersForNotificationRequest < Struct.new(
  :account_id,
  :budget_name,
  :notification,
  :max_results,
  :next_token)
  include Aws::Structure
end