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.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags associated with a budget or budget action resource.
-
#tag_resource(params = {}) ⇒ Struct
Creates tags for a budget or budget action resource.
-
#untag_resource(params = {}) ⇒ Struct
Deletes tags associated with a budget or budget action resource.
-
#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.
453 454 455 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 453 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.
575 576 577 578 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 575 def create_budget(params = {}, = {}) req = build_request(:create_budget, params) req.send_request() end |
#create_budget_action(params = {}) ⇒ Types::CreateBudgetActionResponse
Creates a budget action.
676 677 678 679 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 676 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.
724 725 726 727 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 724 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.
768 769 770 771 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 768 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.
796 797 798 799 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 796 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_budget_action(params = {}) ⇒ Types::DeleteBudgetActionResponse
Deletes a budget action.
861 862 863 864 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 861 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.
899 900 901 902 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 899 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.
944 945 946 947 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 944 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1014 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1079 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.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1167 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.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1232 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.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1302 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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1349 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.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1425 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.
1506 1507 1508 1509 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1506 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.
1556 1557 1558 1559 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1556 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.
1613 1614 1615 1616 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1613 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.
1659 1660 1661 1662 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1659 def execute_budget_action(params = {}, = {}) req = build_request(:execute_budget_action, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists tags associated with a budget or budget action resource.
1687 1688 1689 1690 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1687 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Creates tags for a budget or budget action resource.
1716 1717 1718 1719 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1716 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes tags associated with a budget or budget action resource.
1740 1741 1742 1743 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1740 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1830 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_budget_action(params = {}) ⇒ Types::UpdateBudgetActionResponse
Updates a budget action.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1971 def update_budget_action(params = {}, = {}) req = build_request(:update_budget_action, params) req.send_request() end |
#update_notification(params = {}) ⇒ Struct
Updates a notification.
2016 2017 2018 2019 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2016 def update_notification(params = {}, = {}) req = build_request(:update_notification, params) req.send_request() end |
#update_subscriber(params = {}) ⇒ Struct
Updates a subscriber.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2065 def update_subscriber(params = {}, = {}) req = build_request(:update_subscriber, params) req.send_request() end |