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
    threshold_type: "PERCENTAGE", # accepts PERCENTAGE, ABSOLUTE_VALUE
    notification_state: "OK", # accepts OK, ALARM
  },
  max_results: 1,
  next_token: "GenericString",
}

Request of DescribeSubscribersForNotification

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The accountId that is associated with the budget whose subscribers you want descriptions of.

Returns:

  • (String)


996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 996

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

#budget_nameString

The name of the budget whose subscribers you want descriptions of.

Returns:

  • (String)


996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 996

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

#max_resultsInteger

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

Returns:

  • (Integer)


996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 996

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

#next_tokenString

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Returns:

  • (String)


996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 996

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

#notificationTypes::Notification

The notification whose subscribers you want to list.

Returns:



996
997
998
999
1000
1001
1002
1003
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 996

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