Class: Aws::Budgets::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :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. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

  • :stub_responses (Boolean) — default: 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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Budgets::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Budgets::EndpointParameters.

  • :http_continue_timeout (Float) — default: 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.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 478

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.

Examples:

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" => ["DimensionValue"],
    },
    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, CUSTOM
    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, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
    last_updated_time: Time.now,
    auto_adjust_data: {
      auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
      historical_options: {
        budget_adjustment_period: 1, # required
        look_back_available_periods: 1,
      },
      last_auto_adjust_time: Time.now,
    },
    filter_expression: {
      or: [
        {
          # recursive Expression
        },
      ],
      and: [
        {
          # recursive Expression
        },
      ],
      not: {
        # recursive Expression
      },
      dimensions: {
        key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, INVOICING_ENTITY, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, RESERVATION_MODIFIED, TAG_KEY, COST_CATEGORY_NAME
        values: ["Value"], # required
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      tags: {
        key: "TagKey",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      cost_categories: {
        key: "CostCategoryName",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
    },
    metrics: ["BlendedCost"], # accepts BlendedCost, UnblendedCost, AmortizedCost, NetUnblendedCost, NetAmortizedCost, UsageQuantity, NormalizedUsageAmount, Hours
    billing_view_arn: "BillingViewArn",
    health_status: {
      status: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      status_reason: "BILLING_VIEW_NO_ACCESS", # accepts BILLING_VIEW_NO_ACCESS, BILLING_VIEW_UNHEALTHY, FILTER_INVALID, MULTI_YEAR_HISTORICAL_DATA_DISABLED
      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
        },
      ],
    },
  ],
  resource_tags: [
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget.

  • :budget (required, Types::Budget) —

    The budget object that you want to create.

  • :notifications_with_subscribers (Array<Types::NotificationWithSubscribers>) —

    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, Amazon Web Services creates the notifications and subscribers for you.

  • :resource_tags (Array<Types::ResourceTag>) —

    An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource.

Returns:

  • (Struct) —

    Returns an empty response.



645
646
647
648
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 645

def create_budget(params = {}, options = {})
  req = build_request(:create_budget, params)
  req.send_request(options)
end

#create_budget_action(params = {}) ⇒ Types::CreateBudgetActionResponse

Creates a budget action.

Examples:

Request syntax with placeholder values


resp = client.create_budget_action({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  notification_type: "ACTUAL", # required, accepts ACTUAL, FORECASTED
  action_type: "APPLY_IAM_POLICY", # required, accepts APPLY_IAM_POLICY, APPLY_SCP_POLICY, RUN_SSM_DOCUMENTS
  action_threshold: { # required
    action_threshold_value: 1.0, # required
    action_threshold_type: "PERCENTAGE", # required, accepts PERCENTAGE, ABSOLUTE_VALUE
  },
  definition: { # required
    iam_action_definition: {
      policy_arn: "PolicyArn", # required
      roles: ["Role"],
      groups: ["Group"],
      users: ["User"],
    },
    scp_action_definition: {
      policy_id: "PolicyId", # required
      target_ids: ["TargetId"], # required
    },
    ssm_action_definition: {
      action_sub_type: "STOP_EC2_INSTANCES", # required, accepts STOP_EC2_INSTANCES, STOP_RDS_INSTANCES
      region: "Region", # required
      instance_ids: ["InstanceId"], # required
    },
  },
  execution_role_arn: "RoleArn", # required
  approval_model: "AUTOMATIC", # required, accepts AUTOMATIC, MANUAL
  subscribers: [ # required
    {
      subscription_type: "SNS", # required, accepts SNS, EMAIL
      address: "SubscriberAddress", # required
    },
  ],
  resource_tags: [
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Response structure


resp. #=> String
resp.budget_name #=> String
resp.action_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :notification_type (required, String) —

    The type of a notification. It must be ACTUAL or FORECASTED.

  • :action_type (required, String) —

    The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

  • :action_threshold (required, Types::ActionThreshold) —

    The trigger threshold of the action.

  • :definition (required, Types::Definition) —

    Specifies all of the type-specific parameters.

  • :execution_role_arn (required, String) —

    The role passed for action execution and reversion. Roles and actions must be in the same account.

  • :approval_model (required, String) —

    This specifies if the action needs manual or automatic approval.

  • :subscribers (required, Array<Types::Subscriber>) —

    A list of subscribers.

  • :resource_tags (Array<Types::ResourceTag>) —

    An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.

Returns:



746
747
748
749
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 746

def create_budget_action(params = {}, options = {})
  req = build_request(:create_budget_action, params)
  req.send_request(options)
end

#create_notification(params = {}) ⇒ Struct

Creates a notification. You must create the budget before you create the associated notification.

Examples:

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
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget that you want to create a notification for.

  • :budget_name (required, String) —

    The name of the budget that you want Amazon Web Services to notify you about. Budget names must be unique within an account.

  • :notification (required, Types::Notification) —

    The notification that you want to create.

  • :subscribers (required, Array<Types::Subscriber>) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.



794
795
796
797
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 794

def create_notification(params = {}, options = {})
  req = build_request(:create_notification, params)
  req.send_request(options)
end

#create_subscriber(params = {}) ⇒ Struct

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

Examples:

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
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget that you want to create a subscriber for.

  • :budget_name (required, String) —

    The name of the budget that you want to subscribe to. Budget names must be unique within an account.

  • :notification (required, Types::Notification) —

    The notification that you want to create a subscriber for.

  • :subscriber (required, Types::Subscriber) —

    The subscriber that you want to associate with a budget notification.

Returns:

  • (Struct) —

    Returns an empty response.



838
839
840
841
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 838

def create_subscriber(params = {}, options = {})
  req = build_request(:create_subscriber, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_budget({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget that you want to delete.

  • :budget_name (required, String) —

    The name of the budget that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.



866
867
868
869
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 866

def delete_budget(params = {}, options = {})
  req = build_request(:delete_budget, params)
  req.send_request(options)
end

#delete_budget_action(params = {}) ⇒ Types::DeleteBudgetActionResponse

Deletes a budget action.

Examples:

Request syntax with placeholder values


resp = client.delete_budget_action({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  action_id: "ActionId", # required
})

Response structure


resp. #=> String
resp.budget_name #=> String
resp.action.action_id #=> String
resp.action.budget_name #=> String
resp.action.notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.action.action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.action.action_threshold.action_threshold_value #=> Float
resp.action.action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.action.definition.iam_action_definition.policy_arn #=> String
resp.action.definition.iam_action_definition.roles #=> Array
resp.action.definition.iam_action_definition.roles[0] #=> String
resp.action.definition.iam_action_definition.groups #=> Array
resp.action.definition.iam_action_definition.groups[0] #=> String
resp.action.definition.iam_action_definition.users #=> Array
resp.action.definition.iam_action_definition.users[0] #=> String
resp.action.definition.scp_action_definition.policy_id #=> String
resp.action.definition.scp_action_definition.target_ids #=> Array
resp.action.definition.scp_action_definition.target_ids[0] #=> String
resp.action.definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.action.definition.ssm_action_definition.region #=> String
resp.action.definition.ssm_action_definition.instance_ids #=> Array
resp.action.definition.ssm_action_definition.instance_ids[0] #=> String
resp.action.execution_role_arn #=> String
resp.action.approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.action.status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.action.subscribers #=> Array
resp.action.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.action.subscribers[0].address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :action_id (required, String) —

    A system-generated universally unique identifier (UUID) for the action.

Returns:



931
932
933
934
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 931

def delete_budget_action(params = {}, options = {})
  req = build_request(:delete_budget_action, params)
  req.send_request(options)
end

#delete_notification(params = {}) ⇒ Struct

Deletes a notification.

Deleting a notification also deletes the subscribers that are associated with the notification.

Examples:

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
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose notification you want to delete.

  • :budget_name (required, String) —

    The name of the budget whose notification you want to delete.

  • :notification (required, Types::Notification) —

    The notification that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.



969
970
971
972
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 969

def delete_notification(params = {}, options = {})
  req = build_request(:delete_notification, params)
  req.send_request(options)
end

#delete_subscriber(params = {}) ⇒ Struct

Deletes a subscriber.

Deleting the last subscriber to a notification also deletes the notification.

Examples:

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
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose subscriber you want to delete.

  • :budget_name (required, String) —

    The name of the budget whose subscriber you want to delete.

  • :notification (required, Types::Notification) —

    The notification whose subscriber you want to delete.

  • :subscriber (required, Types::Subscriber) —

    The subscriber that you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1014
1015
1016
1017
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1014

def delete_subscriber(params = {}, options = {})
  req = build_request(:delete_subscriber, params)
  req.send_request(options)
end

#describe_budget(params = {}) ⇒ Types::DescribeBudgetResponse

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

Examples:

Request syntax with placeholder values


resp = client.describe_budget({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  show_filter_expression: false,
})

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", "CUSTOM"
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", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE"
resp.budget.last_updated_time #=> Time
resp.budget.auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST"
resp.budget.auto_adjust_data.historical_options.budget_adjustment_period #=> Integer
resp.budget.auto_adjust_data.historical_options.look_back_available_periods #=> Integer
resp.budget.auto_adjust_data.last_auto_adjust_time #=> Time
resp.budget.filter_expression.or #=> Array
resp.budget.filter_expression.or[0] #=> Types::Expression
resp.budget.filter_expression.and #=> Array
resp.budget.filter_expression.and[0] #=> Types::Expression
resp.budget.filter_expression.not #=> Types::Expression
resp.budget.filter_expression.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "OPERATING_SYSTEM", "TENANCY", "SCOPE", "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", "INVOICING_ENTITY", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "RESERVATION_MODIFIED", "TAG_KEY", "COST_CATEGORY_NAME"
resp.budget.filter_expression.dimensions.values #=> Array
resp.budget.filter_expression.dimensions.values[0] #=> String
resp.budget.filter_expression.dimensions.match_options #=> Array
resp.budget.filter_expression.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget.filter_expression.tags.key #=> String
resp.budget.filter_expression.tags.values #=> Array
resp.budget.filter_expression.tags.values[0] #=> String
resp.budget.filter_expression.tags.match_options #=> Array
resp.budget.filter_expression.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget.filter_expression.cost_categories.key #=> String
resp.budget.filter_expression.cost_categories.values #=> Array
resp.budget.filter_expression.cost_categories.values[0] #=> String
resp.budget.filter_expression.cost_categories.match_options #=> Array
resp.budget.filter_expression.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget.metrics #=> Array
resp.budget.metrics[0] #=> String, one of "BlendedCost", "UnblendedCost", "AmortizedCost", "NetUnblendedCost", "NetAmortizedCost", "UsageQuantity", "NormalizedUsageAmount", "Hours"
resp.budget.billing_view_arn #=> String
resp.budget.health_status.status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.budget.health_status.status_reason #=> String, one of "BILLING_VIEW_NO_ACCESS", "BILLING_VIEW_UNHEALTHY", "FILTER_INVALID", "MULTI_YEAR_HISTORICAL_DATA_DISABLED"
resp.budget.health_status.last_updated_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget that you want a description of.

  • :budget_name (required, String) —

    The name of the budget that you want a description of.

  • :show_filter_expression (Boolean) —

    Specifies whether the response includes the filter expression associated with the budget. By showing the filter expression, you can see detailed filtering logic applied to the budget, such as Amazon Web Services services or tags that are being tracked.

Returns:



1117
1118
1119
1120
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1117

def describe_budget(params = {}, options = {})
  req = build_request(:describe_budget, params)
  req.send_request(options)
end

#describe_budget_action(params = {}) ⇒ Types::DescribeBudgetActionResponse

Describes a budget action detail.

Examples:

Request syntax with placeholder values


resp = client.describe_budget_action({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  action_id: "ActionId", # required
})

Response structure


resp. #=> String
resp.budget_name #=> String
resp.action.action_id #=> String
resp.action.budget_name #=> String
resp.action.notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.action.action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.action.action_threshold.action_threshold_value #=> Float
resp.action.action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.action.definition.iam_action_definition.policy_arn #=> String
resp.action.definition.iam_action_definition.roles #=> Array
resp.action.definition.iam_action_definition.roles[0] #=> String
resp.action.definition.iam_action_definition.groups #=> Array
resp.action.definition.iam_action_definition.groups[0] #=> String
resp.action.definition.iam_action_definition.users #=> Array
resp.action.definition.iam_action_definition.users[0] #=> String
resp.action.definition.scp_action_definition.policy_id #=> String
resp.action.definition.scp_action_definition.target_ids #=> Array
resp.action.definition.scp_action_definition.target_ids[0] #=> String
resp.action.definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.action.definition.ssm_action_definition.region #=> String
resp.action.definition.ssm_action_definition.instance_ids #=> Array
resp.action.definition.ssm_action_definition.instance_ids[0] #=> String
resp.action.execution_role_arn #=> String
resp.action.approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.action.status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.action.subscribers #=> Array
resp.action.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.action.subscribers[0].address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :action_id (required, String) —

    A system-generated universally unique identifier (UUID) for the action.

Returns:



1182
1183
1184
1185
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1182

def describe_budget_action(params = {}, options = {})
  req = build_request(:describe_budget_action, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_budget_action_histories({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  action_id: "ActionId", # required
  time_period: {
    start: Time.now,
    end: Time.now,
  },
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.action_histories #=> Array
resp.action_histories[0].timestamp #=> Time
resp.action_histories[0].status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.action_histories[0].event_type #=> String, one of "SYSTEM", "CREATE_ACTION", "DELETE_ACTION", "UPDATE_ACTION", "EXECUTE_ACTION"
resp.action_histories[0].action_history_details.message #=> String
resp.action_histories[0].action_history_details.action.action_id #=> String
resp.action_histories[0].action_history_details.action.budget_name #=> String
resp.action_histories[0].action_history_details.action.notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.action_histories[0].action_history_details.action.action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.action_histories[0].action_history_details.action.action_threshold.action_threshold_value #=> Float
resp.action_histories[0].action_history_details.action.action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.policy_arn #=> String
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.roles #=> Array
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.roles[0] #=> String
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.groups #=> Array
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.groups[0] #=> String
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.users #=> Array
resp.action_histories[0].action_history_details.action.definition.iam_action_definition.users[0] #=> String
resp.action_histories[0].action_history_details.action.definition.scp_action_definition.policy_id #=> String
resp.action_histories[0].action_history_details.action.definition.scp_action_definition.target_ids #=> Array
resp.action_histories[0].action_history_details.action.definition.scp_action_definition.target_ids[0] #=> String
resp.action_histories[0].action_history_details.action.definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.action_histories[0].action_history_details.action.definition.ssm_action_definition.region #=> String
resp.action_histories[0].action_history_details.action.definition.ssm_action_definition.instance_ids #=> Array
resp.action_histories[0].action_history_details.action.definition.ssm_action_definition.instance_ids[0] #=> String
resp.action_histories[0].action_history_details.action.execution_role_arn #=> String
resp.action_histories[0].action_history_details.action.approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.action_histories[0].action_history_details.action.status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.action_histories[0].action_history_details.action.subscribers #=> Array
resp.action_histories[0].action_history_details.action.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.action_histories[0].action_history_details.action.subscribers[0].address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :action_id (required, String) —

    A system-generated universally unique identifier (UUID) for the action.

  • :time_period (Types::TimePeriod) —

    The period of time that's covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

  • :max_results (Integer) —

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • :next_token (String) —

    A generic string.

Returns:



1270
1271
1272
1273
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1270

def describe_budget_action_histories(params = {}, options = {})
  req = build_request(:describe_budget_action_histories, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.actions #=> Array
resp.actions[0].action_id #=> String
resp.actions[0].budget_name #=> String
resp.actions[0].notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.actions[0].action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.actions[0].action_threshold.action_threshold_value #=> Float
resp.actions[0].action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.actions[0].definition.iam_action_definition.policy_arn #=> String
resp.actions[0].definition.iam_action_definition.roles #=> Array
resp.actions[0].definition.iam_action_definition.roles[0] #=> String
resp.actions[0].definition.iam_action_definition.groups #=> Array
resp.actions[0].definition.iam_action_definition.groups[0] #=> String
resp.actions[0].definition.iam_action_definition.users #=> Array
resp.actions[0].definition.iam_action_definition.users[0] #=> String
resp.actions[0].definition.scp_action_definition.policy_id #=> String
resp.actions[0].definition.scp_action_definition.target_ids #=> Array
resp.actions[0].definition.scp_action_definition.target_ids[0] #=> String
resp.actions[0].definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.actions[0].definition.ssm_action_definition.region #=> String
resp.actions[0].definition.ssm_action_definition.instance_ids #=> Array
resp.actions[0].definition.ssm_action_definition.instance_ids[0] #=> String
resp.actions[0].execution_role_arn #=> String
resp.actions[0].approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.actions[0].status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.actions[0].subscribers #=> Array
resp.actions[0].subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.actions[0].subscribers[0].address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :max_results (Integer) —

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • :next_token (String) —

    A generic string.

Returns:



1335
1336
1337
1338
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1335

def (params = {}, options = {})
  req = build_request(:describe_budget_actions_for_account, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_budget_actions_for_budget({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp.actions #=> Array
resp.actions[0].action_id #=> String
resp.actions[0].budget_name #=> String
resp.actions[0].notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.actions[0].action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.actions[0].action_threshold.action_threshold_value #=> Float
resp.actions[0].action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.actions[0].definition.iam_action_definition.policy_arn #=> String
resp.actions[0].definition.iam_action_definition.roles #=> Array
resp.actions[0].definition.iam_action_definition.roles[0] #=> String
resp.actions[0].definition.iam_action_definition.groups #=> Array
resp.actions[0].definition.iam_action_definition.groups[0] #=> String
resp.actions[0].definition.iam_action_definition.users #=> Array
resp.actions[0].definition.iam_action_definition.users[0] #=> String
resp.actions[0].definition.scp_action_definition.policy_id #=> String
resp.actions[0].definition.scp_action_definition.target_ids #=> Array
resp.actions[0].definition.scp_action_definition.target_ids[0] #=> String
resp.actions[0].definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.actions[0].definition.ssm_action_definition.region #=> String
resp.actions[0].definition.ssm_action_definition.instance_ids #=> Array
resp.actions[0].definition.ssm_action_definition.instance_ids[0] #=> String
resp.actions[0].execution_role_arn #=> String
resp.actions[0].approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.actions[0].status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.actions[0].subscribers #=> Array
resp.actions[0].subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.actions[0].subscribers[0].address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :max_results (Integer) —

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • :next_token (String) —

    A generic string.

Returns:



1405
1406
1407
1408
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1405

def describe_budget_actions_for_budget(params = {}, options = {})
  req = build_request(:describe_budget_actions_for_budget, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.({
  account_id: "AccountId", # required
  max_results: 1,
  next_token: "GenericString",
})

Response structure


resp. #=> Array
resp.[0].notifications #=> Array
resp.[0].notifications[0].notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.[0].notifications[0].comparison_operator #=> String, one of "GREATER_THAN", "LESS_THAN", "EQUAL_TO"
resp.[0].notifications[0].threshold #=> Float
resp.[0].notifications[0].threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.[0].notifications[0].notification_state #=> String, one of "OK", "ALARM"
resp.[0].budget_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :max_results (Integer) —

    An integer that represents how many budgets a paginated response contains. The default is 50.

  • :next_token (String) —

    A generic string.

Returns:



1452
1453
1454
1455
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1452

def (params = {}, options = {})
  req = build_request(:describe_budget_notifications_for_account, params)
  req.send_request(options)
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.

Examples:

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",
})

Response structure


resp.budget_performance_history.budget_name #=> String
resp.budget_performance_history.budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_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", "CUSTOM"
resp.budget_performance_history.billing_view_arn #=> String
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.budget_performance_history.filter_expression.or #=> Array
resp.budget_performance_history.filter_expression.or[0] #=> Types::Expression
resp.budget_performance_history.filter_expression.and #=> Array
resp.budget_performance_history.filter_expression.and[0] #=> Types::Expression
resp.budget_performance_history.filter_expression.not #=> Types::Expression
resp.budget_performance_history.filter_expression.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "OPERATING_SYSTEM", "TENANCY", "SCOPE", "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", "INVOICING_ENTITY", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "RESERVATION_MODIFIED", "TAG_KEY", "COST_CATEGORY_NAME"
resp.budget_performance_history.filter_expression.dimensions.values #=> Array
resp.budget_performance_history.filter_expression.dimensions.values[0] #=> String
resp.budget_performance_history.filter_expression.dimensions.match_options #=> Array
resp.budget_performance_history.filter_expression.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget_performance_history.filter_expression.tags.key #=> String
resp.budget_performance_history.filter_expression.tags.values #=> Array
resp.budget_performance_history.filter_expression.tags.values[0] #=> String
resp.budget_performance_history.filter_expression.tags.match_options #=> Array
resp.budget_performance_history.filter_expression.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget_performance_history.filter_expression.cost_categories.key #=> String
resp.budget_performance_history.filter_expression.cost_categories.values #=> Array
resp.budget_performance_history.filter_expression.cost_categories.values[0] #=> String
resp.budget_performance_history.filter_expression.cost_categories.match_options #=> Array
resp.budget_performance_history.filter_expression.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budget_performance_history.metrics #=> Array
resp.budget_performance_history.metrics[0] #=> String, one of "BlendedCost", "UnblendedCost", "AmortizedCost", "NetUnblendedCost", "NetAmortizedCost", "UsageQuantity", "NormalizedUsageAmount", "Hours"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :time_period (Types::TimePeriod) —

    Retrieves how often the budget went into an ALARM state for the specified time period.

  • :max_results (Integer) —

    An integer that represents how many entries a paginated response contains. The maximum is 100.

  • :next_token (String) —

    A generic string.

Returns:



1551
1552
1553
1554
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1551

def describe_budget_performance_history(params = {}, options = {})
  req = build_request(:describe_budget_performance_history, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.describe_budgets({
  account_id: "AccountId", # required
  max_results: 1,
  next_token: "GenericString",
  show_filter_expression: false,
})

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", "CUSTOM"
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", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE"
resp.budgets[0].last_updated_time #=> Time
resp.budgets[0].auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST"
resp.budgets[0].auto_adjust_data.historical_options.budget_adjustment_period #=> Integer
resp.budgets[0].auto_adjust_data.historical_options.look_back_available_periods #=> Integer
resp.budgets[0].auto_adjust_data.last_auto_adjust_time #=> Time
resp.budgets[0].filter_expression.or #=> Array
resp.budgets[0].filter_expression.or[0] #=> Types::Expression
resp.budgets[0].filter_expression.and #=> Array
resp.budgets[0].filter_expression.and[0] #=> Types::Expression
resp.budgets[0].filter_expression.not #=> Types::Expression
resp.budgets[0].filter_expression.dimensions.key #=> String, one of "AZ", "INSTANCE_TYPE", "LINKED_ACCOUNT", "LINKED_ACCOUNT_NAME", "OPERATION", "PURCHASE_TYPE", "REGION", "SERVICE", "SERVICE_CODE", "USAGE_TYPE", "USAGE_TYPE_GROUP", "RECORD_TYPE", "OPERATING_SYSTEM", "TENANCY", "SCOPE", "PLATFORM", "SUBSCRIPTION_ID", "LEGAL_ENTITY_NAME", "INVOICING_ENTITY", "DEPLOYMENT_OPTION", "DATABASE_ENGINE", "CACHE_ENGINE", "INSTANCE_TYPE_FAMILY", "BILLING_ENTITY", "RESERVATION_ID", "RESOURCE_ID", "RIGHTSIZING_TYPE", "SAVINGS_PLANS_TYPE", "SAVINGS_PLAN_ARN", "PAYMENT_OPTION", "RESERVATION_MODIFIED", "TAG_KEY", "COST_CATEGORY_NAME"
resp.budgets[0].filter_expression.dimensions.values #=> Array
resp.budgets[0].filter_expression.dimensions.values[0] #=> String
resp.budgets[0].filter_expression.dimensions.match_options #=> Array
resp.budgets[0].filter_expression.dimensions.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budgets[0].filter_expression.tags.key #=> String
resp.budgets[0].filter_expression.tags.values #=> Array
resp.budgets[0].filter_expression.tags.values[0] #=> String
resp.budgets[0].filter_expression.tags.match_options #=> Array
resp.budgets[0].filter_expression.tags.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budgets[0].filter_expression.cost_categories.key #=> String
resp.budgets[0].filter_expression.cost_categories.values #=> Array
resp.budgets[0].filter_expression.cost_categories.values[0] #=> String
resp.budgets[0].filter_expression.cost_categories.match_options #=> Array
resp.budgets[0].filter_expression.cost_categories.match_options[0] #=> String, one of "EQUALS", "ABSENT", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "GREATER_THAN_OR_EQUAL", "CASE_SENSITIVE", "CASE_INSENSITIVE"
resp.budgets[0].metrics #=> Array
resp.budgets[0].metrics[0] #=> String, one of "BlendedCost", "UnblendedCost", "AmortizedCost", "NetUnblendedCost", "NetAmortizedCost", "UsageQuantity", "NormalizedUsageAmount", "Hours"
resp.budgets[0].billing_view_arn #=> String
resp.budgets[0].health_status.status #=> String, one of "HEALTHY", "UNHEALTHY"
resp.budgets[0].health_status.status_reason #=> String, one of "BILLING_VIEW_NO_ACCESS", "BILLING_VIEW_UNHEALTHY", "FILTER_INVALID", "MULTI_YEAR_HISTORICAL_DATA_DISABLED"
resp.budgets[0].health_status.last_updated_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budgets that you want to describe.

  • :max_results (Integer) —

    An integer that represents how many budgets a paginated response contains. The default is 100.

  • :next_token (String) —

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

  • :show_filter_expression (Boolean) —

    Specifies whether the response includes the filter expression associated with the budgets. By showing the filter expression, you can see detailed filtering logic applied to the budgets, such as Amazon Web Services services or tags that are being tracked.

Returns:



1665
1666
1667
1668
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1665

def describe_budgets(params = {}, options = {})
  req = build_request(:describe_budgets, params)
  req.send_request(options)
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.

Examples:

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",
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose notifications you want descriptions of.

  • :budget_name (required, String) —

    The name of the budget whose notifications you want descriptions of.

  • :max_results (Integer) —

    An optional integer that represents how many entries a paginated response contains.

  • :next_token (String) —

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Returns:



1715
1716
1717
1718
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1715

def describe_notifications_for_budget(params = {}, options = {})
  req = build_request(:describe_notifications_for_budget, params)
  req.send_request(options)
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.

Examples:

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",
})

Response structure


resp.subscribers #=> Array
resp.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.subscribers[0].address #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose subscribers you want descriptions of.

  • :budget_name (required, String) —

    The name of the budget whose subscribers you want descriptions of.

  • :notification (required, Types::Notification) —

    The notification whose subscribers you want to list.

  • :max_results (Integer) —

    An optional integer that represents how many entries a paginated response contains.

  • :next_token (String) —

    The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

Returns:



1772
1773
1774
1775
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1772

def describe_subscribers_for_notification(params = {}, options = {})
  req = build_request(:describe_subscribers_for_notification, params)
  req.send_request(options)
end

#execute_budget_action(params = {}) ⇒ Types::ExecuteBudgetActionResponse

Executes a budget action.

Examples:

Request syntax with placeholder values


resp = client.execute_budget_action({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  action_id: "ActionId", # required
  execution_type: "APPROVE_BUDGET_ACTION", # required, accepts APPROVE_BUDGET_ACTION, RETRY_BUDGET_ACTION, REVERSE_BUDGET_ACTION, RESET_BUDGET_ACTION
})

Response structure


resp. #=> String
resp.budget_name #=> String
resp.action_id #=> String
resp.execution_type #=> String, one of "APPROVE_BUDGET_ACTION", "RETRY_BUDGET_ACTION", "REVERSE_BUDGET_ACTION", "RESET_BUDGET_ACTION"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :action_id (required, String) —

    A system-generated universally unique identifier (UUID) for the action.

  • :execution_type (required, String) —

    The type of execution.

Returns:



1818
1819
1820
1821
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1818

def execute_budget_action(params = {}, options = {})
  req = build_request(:execute_budget_action, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists tags associated with a budget or budget action resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.resource_tags #=> Array
resp.resource_tags[0].key #=> String
resp.resource_tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The unique identifier for the resource.

Returns:



1846
1847
1848
1849
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1846

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Creates tags for a budget or budget action resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  resource_tags: [ # required
    {
      key: "ResourceTagKey", # required
      value: "ResourceTagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The unique identifier for the resource.

  • :resource_tags (required, Array<Types::ResourceTag>) —

    The tags associated with the resource.

Returns:

  • (Struct) —

    Returns an empty response.



1875
1876
1877
1878
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1875

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes tags associated with a budget or budget action resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  resource_tag_keys: ["ResourceTagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The unique identifier for the resource.

  • :resource_tag_keys (required, Array<String>) —

    The key that's associated with the tag.

Returns:

  • (Struct) —

    Returns an empty response.



1899
1900
1901
1902
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 1899

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

Examples:

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" => ["DimensionValue"],
    },
    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, CUSTOM
    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, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
    last_updated_time: Time.now,
    auto_adjust_data: {
      auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
      historical_options: {
        budget_adjustment_period: 1, # required
        look_back_available_periods: 1,
      },
      last_auto_adjust_time: Time.now,
    },
    filter_expression: {
      or: [
        {
          # recursive Expression
        },
      ],
      and: [
        {
          # recursive Expression
        },
      ],
      not: {
        # recursive Expression
      },
      dimensions: {
        key: "AZ", # required, accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, LINKED_ACCOUNT_NAME, OPERATION, PURCHASE_TYPE, REGION, SERVICE, SERVICE_CODE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, INVOICING_ENTITY, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID, RESOURCE_ID, RIGHTSIZING_TYPE, SAVINGS_PLANS_TYPE, SAVINGS_PLAN_ARN, PAYMENT_OPTION, RESERVATION_MODIFIED, TAG_KEY, COST_CATEGORY_NAME
        values: ["Value"], # required
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      tags: {
        key: "TagKey",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
      cost_categories: {
        key: "CostCategoryName",
        values: ["Value"],
        match_options: ["EQUALS"], # accepts EQUALS, ABSENT, STARTS_WITH, ENDS_WITH, CONTAINS, GREATER_THAN_OR_EQUAL, CASE_SENSITIVE, CASE_INSENSITIVE
      },
    },
    metrics: ["BlendedCost"], # accepts BlendedCost, UnblendedCost, AmortizedCost, NetUnblendedCost, NetAmortizedCost, UsageQuantity, NormalizedUsageAmount, Hours
    billing_view_arn: "BillingViewArn",
    health_status: {
      status: "HEALTHY", # accepts HEALTHY, UNHEALTHY
      status_reason: "BILLING_VIEW_NO_ACCESS", # accepts BILLING_VIEW_NO_ACCESS, BILLING_VIEW_UNHEALTHY, FILTER_INVALID, MULTI_YEAR_HISTORICAL_DATA_DISABLED
      last_updated_time: Time.now,
    },
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget that you want to update.

  • :new_budget (required, Types::Budget) —

    The budget that you want to update your budget to.

Returns:

  • (Struct) —

    Returns an empty response.



2034
2035
2036
2037
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2034

def update_budget(params = {}, options = {})
  req = build_request(:update_budget, params)
  req.send_request(options)
end

#update_budget_action(params = {}) ⇒ Types::UpdateBudgetActionResponse

Updates a budget action.

Examples:

Request syntax with placeholder values


resp = client.update_budget_action({
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  action_id: "ActionId", # required
  notification_type: "ACTUAL", # accepts ACTUAL, FORECASTED
  action_threshold: {
    action_threshold_value: 1.0, # required
    action_threshold_type: "PERCENTAGE", # required, accepts PERCENTAGE, ABSOLUTE_VALUE
  },
  definition: {
    iam_action_definition: {
      policy_arn: "PolicyArn", # required
      roles: ["Role"],
      groups: ["Group"],
      users: ["User"],
    },
    scp_action_definition: {
      policy_id: "PolicyId", # required
      target_ids: ["TargetId"], # required
    },
    ssm_action_definition: {
      action_sub_type: "STOP_EC2_INSTANCES", # required, accepts STOP_EC2_INSTANCES, STOP_RDS_INSTANCES
      region: "Region", # required
      instance_ids: ["InstanceId"], # required
    },
  },
  execution_role_arn: "RoleArn",
  approval_model: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
  subscribers: [
    {
      subscription_type: "SNS", # required, accepts SNS, EMAIL
      address: "SubscriberAddress", # required
    },
  ],
})

Response structure


resp. #=> String
resp.budget_name #=> String
resp.old_action.action_id #=> String
resp.old_action.budget_name #=> String
resp.old_action.notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.old_action.action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.old_action.action_threshold.action_threshold_value #=> Float
resp.old_action.action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.old_action.definition.iam_action_definition.policy_arn #=> String
resp.old_action.definition.iam_action_definition.roles #=> Array
resp.old_action.definition.iam_action_definition.roles[0] #=> String
resp.old_action.definition.iam_action_definition.groups #=> Array
resp.old_action.definition.iam_action_definition.groups[0] #=> String
resp.old_action.definition.iam_action_definition.users #=> Array
resp.old_action.definition.iam_action_definition.users[0] #=> String
resp.old_action.definition.scp_action_definition.policy_id #=> String
resp.old_action.definition.scp_action_definition.target_ids #=> Array
resp.old_action.definition.scp_action_definition.target_ids[0] #=> String
resp.old_action.definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.old_action.definition.ssm_action_definition.region #=> String
resp.old_action.definition.ssm_action_definition.instance_ids #=> Array
resp.old_action.definition.ssm_action_definition.instance_ids[0] #=> String
resp.old_action.execution_role_arn #=> String
resp.old_action.approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.old_action.status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.old_action.subscribers #=> Array
resp.old_action.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.old_action.subscribers[0].address #=> String
resp.new_action.action_id #=> String
resp.new_action.budget_name #=> String
resp.new_action.notification_type #=> String, one of "ACTUAL", "FORECASTED"
resp.new_action.action_type #=> String, one of "APPLY_IAM_POLICY", "APPLY_SCP_POLICY", "RUN_SSM_DOCUMENTS"
resp.new_action.action_threshold.action_threshold_value #=> Float
resp.new_action.action_threshold.action_threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
resp.new_action.definition.iam_action_definition.policy_arn #=> String
resp.new_action.definition.iam_action_definition.roles #=> Array
resp.new_action.definition.iam_action_definition.roles[0] #=> String
resp.new_action.definition.iam_action_definition.groups #=> Array
resp.new_action.definition.iam_action_definition.groups[0] #=> String
resp.new_action.definition.iam_action_definition.users #=> Array
resp.new_action.definition.iam_action_definition.users[0] #=> String
resp.new_action.definition.scp_action_definition.policy_id #=> String
resp.new_action.definition.scp_action_definition.target_ids #=> Array
resp.new_action.definition.scp_action_definition.target_ids[0] #=> String
resp.new_action.definition.ssm_action_definition.action_sub_type #=> String, one of "STOP_EC2_INSTANCES", "STOP_RDS_INSTANCES"
resp.new_action.definition.ssm_action_definition.region #=> String
resp.new_action.definition.ssm_action_definition.instance_ids #=> Array
resp.new_action.definition.ssm_action_definition.instance_ids[0] #=> String
resp.new_action.execution_role_arn #=> String
resp.new_action.approval_model #=> String, one of "AUTOMATIC", "MANUAL"
resp.new_action.status #=> String, one of "STANDBY", "PENDING", "EXECUTION_IN_PROGRESS", "EXECUTION_SUCCESS", "EXECUTION_FAILURE", "REVERSE_IN_PROGRESS", "REVERSE_SUCCESS", "REVERSE_FAILURE", "RESET_IN_PROGRESS", "RESET_FAILURE"
resp.new_action.subscribers #=> Array
resp.new_action.subscribers[0].subscription_type #=> String, one of "SNS", "EMAIL"
resp.new_action.subscribers[0].address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The account ID of the user. It's a 12-digit number.

  • :budget_name (required, String) —

    A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

  • :action_id (required, String) —

    A system-generated universally unique identifier (UUID) for the action.

  • :notification_type (String) —

    The type of a notification. It must be ACTUAL or FORECASTED.

  • :action_threshold (Types::ActionThreshold) —

    The trigger threshold of the action.

  • :definition (Types::Definition) —

    Specifies all of the type-specific parameters.

  • :execution_role_arn (String) —

    The role passed for action execution and reversion. Roles and actions must be in the same account.

  • :approval_model (String) —

    This specifies if the action needs manual or automatic approval.

  • :subscribers (Array<Types::Subscriber>) —

    A list of subscribers.

Returns:



2175
2176
2177
2178
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2175

def update_budget_action(params = {}, options = {})
  req = build_request(:update_budget_action, params)
  req.send_request(options)
end

#update_notification(params = {}) ⇒ Struct

Updates a notification.

Examples:

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
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose notification you want to update.

  • :budget_name (required, String) —

    The name of the budget whose notification you want to update.

  • :old_notification (required, Types::Notification) —

    The previous notification that is associated with a budget.

  • :new_notification (required, Types::Notification) —

    The updated notification to be associated with a budget.

Returns:

  • (Struct) —

    Returns an empty response.



2220
2221
2222
2223
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2220

def update_notification(params = {}, options = {})
  req = build_request(:update_notification, params)
  req.send_request(options)
end

#update_subscriber(params = {}) ⇒ Struct

Updates a subscriber.

Examples:

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
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The accountId that is associated with the budget whose subscriber you want to update.

  • :budget_name (required, String) —

    The name of the budget whose subscriber you want to update.

  • :notification (required, Types::Notification) —

    The notification whose subscriber you want to update.

  • :old_subscriber (required, Types::Subscriber) —

    The previous subscriber that is associated with a budget notification.

  • :new_subscriber (required, Types::Subscriber) —

    The updated subscriber that is associated with a budget notification.

Returns:

  • (Struct) —

    Returns an empty response.



2269
2270
2271
2272
 
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/client.rb', line 2269

def update_subscriber(params = {}, options = {})
  req = build_request(:update_subscriber, params)
  req.send_request(options)
end