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.
473 474 475 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 473 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 use case. The
Request Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the Examples section.
Similarly, only one set of filter and metric selections can be
present
in the syntax at one time. Either FilterExpression
and Metrics
or
CostFilters
and CostTypes
, not both or a different combination. We
recommend using FilterExpression
and Metrics
as they provide more
flexible and powerful filtering capabilities. The Request Syntax
section shows the FilterExpression
/Metrics
syntax.
634 635 636 637 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 634 def create_budget(params = {}, = {}) req = build_request(:create_budget, params) req.send_request() end |
#create_budget_action(params = {}) ⇒ Types::CreateBudgetActionResponse
Creates a budget action.
735 736 737 738 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 735 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.
783 784 785 786 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 783 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.
827 828 829 830 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 827 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.
855 856 857 858 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 855 def delete_budget(params = {}, = {}) req = build_request(:delete_budget, params) req.send_request() end |
#delete_budget_action(params = {}) ⇒ Types::DeleteBudgetActionResponse
Deletes a budget action.
920 921 922 923 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 920 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.
958 959 960 961 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 958 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.
1003 1004 1005 1006 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1003 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.
1102 1103 1104 1105 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1102 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.
1167 1168 1169 1170 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1167 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.
1255 1256 1257 1258 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1255 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.
1320 1321 1322 1323 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1320 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1390 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.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1437 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.
1513 1514 1515 1516 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1513 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.
1623 1624 1625 1626 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1623 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.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1673 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1730 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.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1776 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.
1804 1805 1806 1807 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1804 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.
1833 1834 1835 1836 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1833 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.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1857 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.
Similarly, only one set of filter and metric selections can be
present
in the syntax at one time. Either FilterExpression
and Metrics
or
CostFilters
and CostTypes
, not both or a different combination. We
recommend using FilterExpression
and Metrics
as they provide more
flexible and powerful filtering capabilities. The Request Syntax
section shows the FilterExpression
/Metrics
syntax.
1986 1987 1988 1989 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1986 def update_budget(params = {}, = {}) req = build_request(:update_budget, params) req.send_request() end |
#update_budget_action(params = {}) ⇒ Types::UpdateBudgetActionResponse
Updates a budget action.
2127 2128 2129 2130 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2127 def update_budget_action(params = {}, = {}) req = build_request(:update_budget_action, params) req.send_request() end |
#update_notification(params = {}) ⇒ Struct
Updates a notification.
2172 2173 2174 2175 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2172 def update_notification(params = {}, = {}) req = build_request(:update_notification, params) req.send_request() end |
#update_subscriber(params = {}) ⇒ Struct
Updates a subscriber.
2221 2222 2223 2224 |
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2221 def update_subscriber(params = {}, = {}) req = build_request(:update_subscriber, params) req.send_request() end |