You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Budgets::Client OverviewAn API client for AWS Budgets. To construct a client, you need to configure a :region and :credentials.
budgets = Aws::Budgets::Client.new(
region: region_name,
credentials: credentials,
)
See #initialize for a full list of supported configuration options.
RegionYou can configure a default region in the following locations:
ENV['AWS_REGION']Aws.config[:region]Go here for a list of supported regions.
CredentialsDefault credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']Aws.config[:credentials]~/.aws/credentials (more information)You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id and :secret_access_key:
creds = YAML.load(File.read('/path/to/secrets'))
Aws::Budgets::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Attribute Summary collapseConstructs an API client.
Creates a budget and, if included, notifications and subscribers.
Deletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
.
Deletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
.
Describes a budget.
The Request Syntax section shows the BudgetLimit syntax.
Describes a budget action detail.
Describes a budget action history detail.
Describes all of the budget actions for an account.
Describes all of the budget actions for a budget.
Describes the history for DAILY, MONTHLY, and QUARTERLY budgets.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax.
Lists the notifications that are associated with a budget.
.
Lists the subscribers that are associated with a notification.
.
Executes a budget action.
Updates a notification.
.
Waiters polls an API operation until a resource enters a desired state.
Returns the list of supported waiters.
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder#handle, #handle_request, #handle_response
Instance Method Details #create_budget(options = {}) ⇒ StructCreates 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.
Creates a notification. You must create the budget before you create the associated notification.
#create_subscriber(options = {}) ⇒ StructCreates a subscriber. You must create the associated budget and notification before you create the subscriber.
#delete_budget(options = {}) ⇒ StructDeletes 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.
#delete_notification(options = {}) ⇒ StructDeletes a notification.
Deleting a notification also deletes the subscribers that are associated with the notification.
#delete_subscriber(options = {}) ⇒ StructDeletes a subscriber.
Deleting the last subscriber to a notification also deletes the notification.
#describe_budget(options = {}) ⇒ Types::DescribeBudgetResponseDescribes a budget.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
Lists the budgets that are associated with an account.
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.
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 AWS 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.
Waiters polls an API operation until a resource enters a desired state.
Basic UsageWaiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
ConfigurationYou can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name Client Method Default Delay: Default Max Attempts:RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4