# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:budgets) module Aws::Budgets class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :budgets set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::JsonRpc) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::SharedCredentials` - Used for loading credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2 IMDS instance profile - When used by default, the timeouts are # very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentails` to enable retries and extended # timeouts. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is search for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("127.0.0.1") # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client # side monitoring agent is running on, where client metrics will be published via UDP. # # @option options [Integer] :client_side_monitoring_port (31000) # Required for publishing client metrics. The port that the client side monitoring # agent is running on, where client metrics will be published via UDP. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting # to test endpoints. This should be avalid HTTP(S) URI. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (60) # When :endpoint_discovery and :active_endpoint_cache is enabled, # Use this option to config the time interval in seconds for making # requests fetching endpoints information. Defaults to 60 sec. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. # # @option options [Symbol] :retry_jitter (:none) # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (3) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data # checksum errors, networking errors, timeout errors and auth # errors from expired credentials. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (false) # Disables request parameter conversion, validation, and formatting. # Also disable response data type conversions. This option is useful # when you want to ensure the highest level of performance by # avoiding overhead of walking request parameters and response data # structures. # # When `:simple_json` is enabled, the request parameters hash must # be formatted exactly as the DynamoDB API expects. # # @option options [Boolean] :stub_responses (false) # Causes the client to return stubbed responses. By default # fake responses are generated and returned. You can specify # the response data to return or errors to raise by calling # {ClientStubs#stub_responses}. See {ClientStubs} for more information. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before rasing a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set # per-request on the session yeidled by {#session_for}. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idble before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. # # @option options [Float] :http_continue_timeout (1) The number of # seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has # "Expect" header set to "100-continue". Defaults to `nil` which # disables this behaviour. This value can safely be set per # request on the session yeidled by {#session_for}. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle Full path to the SSL # certificate authority bundle file that should be used when # verifying peer certificates. If you do not pass # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default # will be used if available. # # @option options [String] :ssl_ca_directory Full path of the # directory that contains the unbundled SSL certificate # authority files for verifying peer certificates. If you do # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the # system default will be used if available. # def initialize(*args) super end # @!group API Operations # 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][1] section. # # # # [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples # # @option params [required, String] :account_id # The `accountId` that is associated with the budget. # # @option params [required, Types::Budget] :budget # The budget object that you want to create. # # @option params [Array] :notifications_with_subscribers # A notification that you want to associate with a budget. A budget can # have up to five notifications, and each notification can have one SNS # subscriber and up to 10 email subscribers. If you include # notifications and subscribers in your `CreateBudget` call, AWS creates # the notifications and subscribers for you. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_budget({ # account_id: "AccountId", # required # budget: { # required # budget_name: "BudgetName", # required # budget_limit: { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # planned_budget_limits: { # "GenericString" => { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # }, # cost_filters: { # "GenericString" => ["GenericString"], # }, # cost_types: { # include_tax: false, # include_subscription: false, # use_blended: false, # include_refund: false, # include_credit: false, # include_upfront: false, # include_recurring: false, # include_other_subscription: false, # include_support: false, # include_discount: false, # use_amortized: false, # }, # time_unit: "DAILY", # required, accepts DAILY, MONTHLY, QUARTERLY, ANNUALLY # time_period: { # start: Time.now, # end: Time.now, # }, # calculated_spend: { # actual_spend: { # required # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # forecasted_spend: { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # }, # budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE # last_updated_time: Time.now, # }, # notifications_with_subscribers: [ # { # 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 # }, # subscribers: [ # required # { # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # ], # }, # ], # }) # # @overload create_budget(params = {}) # @param [Hash] params ({}) def create_budget(params = {}, options = {}) req = build_request(:create_budget, params) req.send_request(options) end # Creates a notification. You must create the budget before you create # the associated notification. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget that you want to # create a notification for. # # @option params [required, String] :budget_name # The name of the budget that you want AWS to notify you about. Budget # names must be unique within an account. # # @option params [required, Types::Notification] :notification # The notification that you want to create. # # @option params [required, Array] :subscribers # A list of subscribers that you want to associate with the # notification. Each notification can have one SNS subscriber and up to # 10 email subscribers. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_notification({ # 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 # }, # subscribers: [ # required # { # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # ], # }) # # @overload create_notification(params = {}) # @param [Hash] params ({}) def create_notification(params = {}, options = {}) req = build_request(:create_notification, params) req.send_request(options) end # Creates a subscriber. You must create the associated budget and # notification before you create the subscriber. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget that you want to # create a subscriber for. # # @option params [required, String] :budget_name # The name of the budget that you want to subscribe to. Budget names # must be unique within an account. # # @option params [required, Types::Notification] :notification # The notification that you want to create a subscriber for. # # @option params [required, Types::Subscriber] :subscriber # The subscriber that you want to associate with a budget notification. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_subscriber({ # 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 # }, # subscriber: { # required # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # }) # # @overload create_subscriber(params = {}) # @param [Hash] params ({}) def create_subscriber(params = {}, options = {}) req = build_request(:create_subscriber, params) req.send_request(options) end # 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. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget that you want to # delete. # # @option params [required, String] :budget_name # The name of the budget that you want to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_budget({ # account_id: "AccountId", # required # budget_name: "BudgetName", # required # }) # # @overload delete_budget(params = {}) # @param [Hash] params ({}) def delete_budget(params = {}, options = {}) req = build_request(:delete_budget, params) req.send_request(options) end # Deletes a notification. # # Deleting a notification also deletes the subscribers that are # associated with the notification. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose notification # you want to delete. # # @option params [required, String] :budget_name # The name of the budget whose notification you want to delete. # # @option params [required, Types::Notification] :notification # The notification that you want to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_notification({ # 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 # }, # }) # # @overload delete_notification(params = {}) # @param [Hash] params ({}) def delete_notification(params = {}, options = {}) req = build_request(:delete_notification, params) req.send_request(options) end # Deletes a subscriber. # # Deleting the last subscriber to a notification also deletes the # notification. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose subscriber # you want to delete. # # @option params [required, String] :budget_name # The name of the budget whose subscriber you want to delete. # # @option params [required, Types::Notification] :notification # The notification whose subscriber you want to delete. # # @option params [required, Types::Subscriber] :subscriber # The subscriber that you want to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_subscriber({ # 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 # }, # subscriber: { # required # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # }) # # @overload delete_subscriber(params = {}) # @param [Hash] params ({}) def delete_subscriber(params = {}, options = {}) req = build_request(:delete_subscriber, params) req.send_request(options) end # Describes a budget. # # The Request Syntax section shows the `BudgetLimit` syntax. For # `PlannedBudgetLimits`, see the [Examples][1] section. # # # # [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples # # @option params [required, String] :account_id # The `accountId` that is associated with the budget that you want a # description of. # # @option params [required, String] :budget_name # The name of the budget that you want a description of. # # @return [Types::DescribeBudgetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeBudgetResponse#budget #budget} => Types::Budget # # @example Request syntax with placeholder values # # resp = client.describe_budget({ # account_id: "AccountId", # required # budget_name: "BudgetName", # required # }) # # @example Response structure # # resp.budget.budget_name #=> String # resp.budget.budget_limit.amount #=> String # resp.budget.budget_limit.unit #=> String # resp.budget.planned_budget_limits #=> Hash # resp.budget.planned_budget_limits["GenericString"].amount #=> String # resp.budget.planned_budget_limits["GenericString"].unit #=> String # resp.budget.cost_filters #=> Hash # resp.budget.cost_filters["GenericString"] #=> Array # resp.budget.cost_filters["GenericString"][0] #=> String # resp.budget.cost_types.include_tax #=> Boolean # resp.budget.cost_types.include_subscription #=> Boolean # resp.budget.cost_types.use_blended #=> Boolean # resp.budget.cost_types.include_refund #=> Boolean # resp.budget.cost_types.include_credit #=> Boolean # resp.budget.cost_types.include_upfront #=> Boolean # resp.budget.cost_types.include_recurring #=> Boolean # resp.budget.cost_types.include_other_subscription #=> Boolean # resp.budget.cost_types.include_support #=> Boolean # resp.budget.cost_types.include_discount #=> Boolean # resp.budget.cost_types.use_amortized #=> Boolean # resp.budget.time_unit #=> String, one of "DAILY", "MONTHLY", "QUARTERLY", "ANNUALLY" # resp.budget.time_period.start #=> Time # resp.budget.time_period.end #=> Time # resp.budget.calculated_spend.actual_spend.amount #=> String # resp.budget.calculated_spend.actual_spend.unit #=> String # resp.budget.calculated_spend.forecasted_spend.amount #=> String # resp.budget.calculated_spend.forecasted_spend.unit #=> String # resp.budget.budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE" # resp.budget.last_updated_time #=> Time # # @overload describe_budget(params = {}) # @param [Hash] params ({}) def describe_budget(params = {}, options = {}) req = build_request(:describe_budget, params) req.send_request(options) end # Describes the history for `DAILY`, `MONTHLY`, and `QUARTERLY` budgets. # Budget history isn't available for `ANNUAL` budgets. # # @option params [required, String] :account_id # The account ID of the user. It should be a 12-digit number. # # @option params [required, String] :budget_name # A string that represents the budget name. The ":" and "\\" # characters aren't allowed. # # @option params [Types::TimePeriod] :time_period # Retrieves how often the budget went into an `ALARM` state for the # specified time period. # # @option params [Integer] :max_results # An integer that represents how many entries a paginated response # contains. The maximum is 100. # # @option params [String] :next_token # A generic string. # # @return [Types::DescribeBudgetPerformanceHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeBudgetPerformanceHistoryResponse#budget_performance_history #budget_performance_history} => Types::BudgetPerformanceHistory # * {Types::DescribeBudgetPerformanceHistoryResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.describe_budget_performance_history({ # account_id: "AccountId", # required # budget_name: "BudgetName", # required # time_period: { # start: Time.now, # end: Time.now, # }, # max_results: 1, # next_token: "GenericString", # }) # # @example Response structure # # resp.budget_performance_history.budget_name #=> String # resp.budget_performance_history.budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE" # resp.budget_performance_history.cost_filters #=> Hash # resp.budget_performance_history.cost_filters["GenericString"] #=> Array # resp.budget_performance_history.cost_filters["GenericString"][0] #=> String # resp.budget_performance_history.cost_types.include_tax #=> Boolean # resp.budget_performance_history.cost_types.include_subscription #=> Boolean # resp.budget_performance_history.cost_types.use_blended #=> Boolean # resp.budget_performance_history.cost_types.include_refund #=> Boolean # resp.budget_performance_history.cost_types.include_credit #=> Boolean # resp.budget_performance_history.cost_types.include_upfront #=> Boolean # resp.budget_performance_history.cost_types.include_recurring #=> Boolean # resp.budget_performance_history.cost_types.include_other_subscription #=> Boolean # resp.budget_performance_history.cost_types.include_support #=> Boolean # resp.budget_performance_history.cost_types.include_discount #=> Boolean # resp.budget_performance_history.cost_types.use_amortized #=> Boolean # resp.budget_performance_history.time_unit #=> String, one of "DAILY", "MONTHLY", "QUARTERLY", "ANNUALLY" # resp.budget_performance_history.budgeted_and_actual_amounts_list #=> Array # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].budgeted_amount.amount #=> String # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].budgeted_amount.unit #=> String # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].actual_amount.amount #=> String # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].actual_amount.unit #=> String # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].time_period.start #=> Time # resp.budget_performance_history.budgeted_and_actual_amounts_list[0].time_period.end #=> Time # resp.next_token #=> String # # @overload describe_budget_performance_history(params = {}) # @param [Hash] params ({}) def describe_budget_performance_history(params = {}, options = {}) req = build_request(:describe_budget_performance_history, params) req.send_request(options) end # Lists the budgets that are associated with an account. # # The Request Syntax section shows the `BudgetLimit` syntax. For # `PlannedBudgetLimits`, see the [Examples][1] section. # # # # [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples # # @option params [required, String] :account_id # The `accountId` that is associated with the budgets that you want # descriptions of. # # @option params [Integer] :max_results # An optional integer that represents how many entries a paginated # response contains. The maximum is 100. # # @option params [String] :next_token # The pagination token that you include in your request to indicate the # next set of results that you want to retrieve. # # @return [Types::DescribeBudgetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeBudgetsResponse#budgets #budgets} => Array<Types::Budget> # * {Types::DescribeBudgetsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.describe_budgets({ # account_id: "AccountId", # required # max_results: 1, # next_token: "GenericString", # }) # # @example Response structure # # resp.budgets #=> Array # resp.budgets[0].budget_name #=> String # resp.budgets[0].budget_limit.amount #=> String # resp.budgets[0].budget_limit.unit #=> String # resp.budgets[0].planned_budget_limits #=> Hash # resp.budgets[0].planned_budget_limits["GenericString"].amount #=> String # resp.budgets[0].planned_budget_limits["GenericString"].unit #=> String # resp.budgets[0].cost_filters #=> Hash # resp.budgets[0].cost_filters["GenericString"] #=> Array # resp.budgets[0].cost_filters["GenericString"][0] #=> String # resp.budgets[0].cost_types.include_tax #=> Boolean # resp.budgets[0].cost_types.include_subscription #=> Boolean # resp.budgets[0].cost_types.use_blended #=> Boolean # resp.budgets[0].cost_types.include_refund #=> Boolean # resp.budgets[0].cost_types.include_credit #=> Boolean # resp.budgets[0].cost_types.include_upfront #=> Boolean # resp.budgets[0].cost_types.include_recurring #=> Boolean # resp.budgets[0].cost_types.include_other_subscription #=> Boolean # resp.budgets[0].cost_types.include_support #=> Boolean # resp.budgets[0].cost_types.include_discount #=> Boolean # resp.budgets[0].cost_types.use_amortized #=> Boolean # resp.budgets[0].time_unit #=> String, one of "DAILY", "MONTHLY", "QUARTERLY", "ANNUALLY" # resp.budgets[0].time_period.start #=> Time # resp.budgets[0].time_period.end #=> Time # resp.budgets[0].calculated_spend.actual_spend.amount #=> String # resp.budgets[0].calculated_spend.actual_spend.unit #=> String # resp.budgets[0].calculated_spend.forecasted_spend.amount #=> String # resp.budgets[0].calculated_spend.forecasted_spend.unit #=> String # resp.budgets[0].budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE" # resp.budgets[0].last_updated_time #=> Time # resp.next_token #=> String # # @overload describe_budgets(params = {}) # @param [Hash] params ({}) def describe_budgets(params = {}, options = {}) req = build_request(:describe_budgets, params) req.send_request(options) end # Lists the notifications that are associated with a budget. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose notifications # you want descriptions of. # # @option params [required, String] :budget_name # The name of the budget whose notifications you want descriptions of. # # @option params [Integer] :max_results # An optional integer that represents how many entries a paginated # response contains. The maximum is 100. # # @option params [String] :next_token # The pagination token that you include in your request to indicate the # next set of results that you want to retrieve. # # @return [Types::DescribeNotificationsForBudgetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeNotificationsForBudgetResponse#notifications #notifications} => Array<Types::Notification> # * {Types::DescribeNotificationsForBudgetResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.describe_notifications_for_budget({ # account_id: "AccountId", # required # budget_name: "BudgetName", # required # max_results: 1, # next_token: "GenericString", # }) # # @example Response structure # # resp.notifications #=> Array # resp.notifications[0].notification_type #=> String, one of "ACTUAL", "FORECASTED" # resp.notifications[0].comparison_operator #=> String, one of "GREATER_THAN", "LESS_THAN", "EQUAL_TO" # resp.notifications[0].threshold #=> Float # resp.notifications[0].threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE" # resp.notifications[0].notification_state #=> String, one of "OK", "ALARM" # resp.next_token #=> String # # @overload describe_notifications_for_budget(params = {}) # @param [Hash] params ({}) def describe_notifications_for_budget(params = {}, options = {}) req = build_request(:describe_notifications_for_budget, params) req.send_request(options) end # Lists the subscribers that are associated with a notification. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose subscribers # you want descriptions of. # # @option params [required, String] :budget_name # The name of the budget whose subscribers you want descriptions of. # # @option params [required, Types::Notification] :notification # The notification whose subscribers you want to list. # # @option params [Integer] :max_results # An optional integer that represents how many entries a paginated # response contains. The maximum is 100. # # @option params [String] :next_token # The pagination token that you include in your request to indicate the # next set of results that you want to retrieve. # # @return [Types::DescribeSubscribersForNotificationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeSubscribersForNotificationResponse#subscribers #subscribers} => Array<Types::Subscriber> # * {Types::DescribeSubscribersForNotificationResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.describe_subscribers_for_notification({ # 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", # }) # # @example Response structure # # resp.subscribers #=> Array # resp.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL" # resp.subscribers[0].address #=> String # resp.next_token #=> String # # @overload describe_subscribers_for_notification(params = {}) # @param [Hash] params ({}) def describe_subscribers_for_notification(params = {}, options = {}) req = build_request(:describe_subscribers_for_notification, params) req.send_request(options) end # 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][1] section. # # # # [1]: https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples # # @option params [required, String] :account_id # The `accountId` that is associated with the budget that you want to # update. # # @option params [required, Types::Budget] :new_budget # The budget that you want to update your budget to. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_budget({ # account_id: "AccountId", # required # new_budget: { # required # budget_name: "BudgetName", # required # budget_limit: { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # planned_budget_limits: { # "GenericString" => { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # }, # cost_filters: { # "GenericString" => ["GenericString"], # }, # cost_types: { # include_tax: false, # include_subscription: false, # use_blended: false, # include_refund: false, # include_credit: false, # include_upfront: false, # include_recurring: false, # include_other_subscription: false, # include_support: false, # include_discount: false, # use_amortized: false, # }, # time_unit: "DAILY", # required, accepts DAILY, MONTHLY, QUARTERLY, ANNUALLY # time_period: { # start: Time.now, # end: Time.now, # }, # calculated_spend: { # actual_spend: { # required # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # forecasted_spend: { # amount: "NumericValue", # required # unit: "UnitValue", # required # }, # }, # budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE # last_updated_time: Time.now, # }, # }) # # @overload update_budget(params = {}) # @param [Hash] params ({}) def update_budget(params = {}, options = {}) req = build_request(:update_budget, params) req.send_request(options) end # Updates a notification. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose notification # you want to update. # # @option params [required, String] :budget_name # The name of the budget whose notification you want to update. # # @option params [required, Types::Notification] :old_notification # The previous notification that is associated with a budget. # # @option params [required, Types::Notification] :new_notification # The updated notification to be associated with a budget. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_notification({ # account_id: "AccountId", # required # budget_name: "BudgetName", # required # old_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 # }, # new_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 # }, # }) # # @overload update_notification(params = {}) # @param [Hash] params ({}) def update_notification(params = {}, options = {}) req = build_request(:update_notification, params) req.send_request(options) end # Updates a subscriber. # # @option params [required, String] :account_id # The `accountId` that is associated with the budget whose subscriber # you want to update. # # @option params [required, String] :budget_name # The name of the budget whose subscriber you want to update. # # @option params [required, Types::Notification] :notification # The notification whose subscriber you want to update. # # @option params [required, Types::Subscriber] :old_subscriber # The previous subscriber that is associated with a budget notification. # # @option params [required, Types::Subscriber] :new_subscriber # The updated subscriber that is associated with a budget notification. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_subscriber({ # 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 # }, # old_subscriber: { # required # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # new_subscriber: { # required # subscription_type: "SNS", # required, accepts SNS, EMAIL # address: "SubscriberAddress", # required # }, # }) # # @overload update_subscriber(params = {}) # @param [Hash] params ({}) def update_subscriber(params = {}, options = {}) req = build_request(:update_subscriber, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-budgets' context[:gem_version] = '1.25.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end