Class: Aws::Budgets::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Budgets::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb
Overview
An API client for Budgets. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::Budgets::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_budget(params = {}) ⇒ Struct
Creates a budget and, if included, notifications and subscribers.
-
#create_budget_action(params = {}) ⇒ Types::CreateBudgetActionResponse
Creates a budget action.
-
#create_notification(params = {}) ⇒ Struct
Creates a notification.
-
#create_subscriber(params = {}) ⇒ Struct
Creates a subscriber.
-
#delete_budget(params = {}) ⇒ Struct
Deletes a budget.
-
#delete_budget_action(params = {}) ⇒ Types::DeleteBudgetActionResponse
Deletes a budget action.
-
#delete_notification(params = {}) ⇒ Struct
Deletes a notification.
-
#delete_subscriber(params = {}) ⇒ Struct
Deletes a subscriber.
-
#describe_budget(params = {}) ⇒ Types::DescribeBudgetResponse
Describes a budget.
-
#describe_budget_action(params = {}) ⇒ Types::DescribeBudgetActionResponse
Describes a budget action detail.
-
#describe_budget_action_histories(params = {}) ⇒ Types::DescribeBudgetActionHistoriesResponse
Describes a budget action history detail.
-
#describe_budget_actions_for_account(params = {}) ⇒ Types::DescribeBudgetActionsForAccountResponse
Describes all of the budget actions for an account.
-
#describe_budget_actions_for_budget(params = {}) ⇒ Types::DescribeBudgetActionsForBudgetResponse
Describes all of the budget actions for a budget.
-
#describe_budget_notifications_for_account(params = {}) ⇒ Types::DescribeBudgetNotificationsForAccountResponse
Lists the budget names and notifications that are associated with an account.
-
#describe_budget_performance_history(params = {}) ⇒ Types::DescribeBudgetPerformanceHistoryResponse
Describes the history for
DAILY
,MONTHLY
, andQUARTERLY
budgets. -
#describe_budgets(params = {}) ⇒ Types::DescribeBudgetsResponse
Lists the budgets that are associated with an account.
-
#describe_notifications_for_budget(params = {}) ⇒ Types::DescribeNotificationsForBudgetResponse
Lists the notifications that are associated with a budget.
-
#describe_subscribers_for_notification(params = {}) ⇒ Types::DescribeSubscribersForNotificationResponse
Lists the subscribers that are associated with a notification.
-
#execute_budget_action(params = {}) ⇒ Types::ExecuteBudgetActionResponse
Executes a budget action.
-
#update_budget(params = {}) ⇒ Struct
Updates a budget.
-
#update_budget_action(params = {}) ⇒ Types::UpdateBudgetActionResponse
Updates a budget action.
-
#update_notification(params = {}) ⇒ Struct
Updates a notification.
-
#update_subscriber(params = {}) ⇒ Struct
Updates a subscriber.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#create_budget(params = {}) ⇒ Struct
Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in
the syntax at one time. Use the syntax that matches your case. The
Request Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the Examples section.
530 531 532 533 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 530 def create_budget(params = {}, = {}) req = build_request(:create_budget, params) req.send_request() end |
#create_budget_action(params = {}) ⇒ Types::CreateBudgetActionResponse
Creates a budget action.
620 621 622 623 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 620 def create_budget_action(params = {}, = {}) req = build_request(:create_budget_action, params) req.send_request() end |
#create_notification(params = {}) ⇒ Struct
Creates a notification. You must create the budget before you create the associated notification.
668 669 670 671 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 668 def create_notification(params = {}, = {}) req = build_request(:create_notification, params) req.send_request() end |
#create_subscriber(params = {}) ⇒ Struct
Creates a subscriber. You must create the associated budget and notification before you create the subscriber.
712 713 714 715 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 712 def create_subscriber(params = {}, = {}) req = build_request(:create_subscriber, params) req.send_request() end |
#delete_budget(params = {}) ⇒ Struct
Deletes a budget. You can delete your budget at any time.
Deleting a budget also deletes the notifications and subscribers that are associated with that budget.
740 741 742 743 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 740 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_budget_action(params = {}) ⇒ Types::DeleteBudgetActionResponse
Deletes a budget action.
805 806 807 808 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 805 def delete_budget_action(params = {}, = {}) req = build_request(:delete_budget_action, params) req.send_request() end |
#delete_notification(params = {}) ⇒ Struct
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
843 844 845 846 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 843 def delete_notification(params = {}, = {}) req = build_request(:delete_notification, params) req.send_request() end |
#delete_subscriber(params = {}) ⇒ Struct
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
888 889 890 891 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 888 def delete_subscriber(params = {}, = {}) req = build_request(:delete_subscriber, params) req.send_request() end |
#describe_budget(params = {}) ⇒ Types::DescribeBudgetResponse
Describes a budget.
The Request Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the Examples section.
958 959 960 961 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 958 def describe_budget(params = {}, = {}) req = build_request(:describe_budget, params) req.send_request() end |
#describe_budget_action(params = {}) ⇒ Types::DescribeBudgetActionResponse
Describes a budget action detail.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1023 def describe_budget_action(params = {}, = {}) req = build_request(:describe_budget_action, params) req.send_request() end |
#describe_budget_action_histories(params = {}) ⇒ Types::DescribeBudgetActionHistoriesResponse
Describes a budget action history detail.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1111 def describe_budget_action_histories(params = {}, = {}) req = build_request(:describe_budget_action_histories, params) req.send_request() end |
#describe_budget_actions_for_account(params = {}) ⇒ Types::DescribeBudgetActionsForAccountResponse
Describes all of the budget actions for an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1176 1177 1178 1179 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1176 def describe_budget_actions_for_account(params = {}, = {}) req = build_request(:describe_budget_actions_for_account, params) req.send_request() end |
#describe_budget_actions_for_budget(params = {}) ⇒ Types::DescribeBudgetActionsForBudgetResponse
Describes all of the budget actions for a budget.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1246 1247 1248 1249 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1246 def describe_budget_actions_for_budget(params = {}, = {}) req = build_request(:describe_budget_actions_for_budget, params) req.send_request() end |
#describe_budget_notifications_for_account(params = {}) ⇒ Types::DescribeBudgetNotificationsForAccountResponse
Lists the budget names and notifications that are associated with an account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1293 def describe_budget_notifications_for_account(params = {}, = {}) req = build_request(:describe_budget_notifications_for_account, params) req.send_request() end |
#describe_budget_performance_history(params = {}) ⇒ Types::DescribeBudgetPerformanceHistoryResponse
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets.
Budget history isn't available for ANNUAL
budgets.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1369 1370 1371 1372 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1369 def describe_budget_performance_history(params = {}, = {}) req = build_request(:describe_budget_performance_history, params) req.send_request() end |
#describe_budgets(params = {}) ⇒ Types::DescribeBudgetsResponse
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the Examples section.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1450 def describe_budgets(params = {}, = {}) req = build_request(:describe_budgets, params) req.send_request() end |
#describe_notifications_for_budget(params = {}) ⇒ Types::DescribeNotificationsForBudgetResponse
Lists the notifications that are associated with a budget.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1500 def describe_notifications_for_budget(params = {}, = {}) req = build_request(:describe_notifications_for_budget, params) req.send_request() end |
#describe_subscribers_for_notification(params = {}) ⇒ Types::DescribeSubscribersForNotificationResponse
Lists the subscribers that are associated with a notification.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1557 def describe_subscribers_for_notification(params = {}, = {}) req = build_request(:describe_subscribers_for_notification, params) req.send_request() end |
#execute_budget_action(params = {}) ⇒ Types::ExecuteBudgetActionResponse
Executes a budget action.
1603 1604 1605 1606 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1603 def execute_budget_action(params = {}, = {}) req = build_request(:execute_budget_action, params) req.send_request() end |
#update_budget(params = {}) ⇒ Struct
Updates a budget. You can change every part of a budget except for the
budgetName
and the calculatedSpend
. When you modify a budget, the
calculatedSpend
drops to zero until Amazon Web Services has new
usage data to use for forecasting.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in
the syntax at one time. Use the syntax that matches your case. The
Request Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the Examples section.
1693 1694 1695 1696 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1693 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_budget_action(params = {}) ⇒ Types::UpdateBudgetActionResponse
Updates a budget action.
1834 1835 1836 1837 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1834 def update_budget_action(params = {}, = {}) req = build_request(:update_budget_action, params) req.send_request() end |
#update_notification(params = {}) ⇒ Struct
Updates a notification.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1879 def update_notification(params = {}, = {}) req = build_request(:update_notification, params) req.send_request() end |
#update_subscriber(params = {}) ⇒ Struct
Updates a subscriber.
1928 1929 1930 1931 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1928 def update_subscriber(params = {}, = {}) req = build_request(:update_subscriber, params) req.send_request() end |