aws-sdk-budgets 1.47.0 → 1.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-budgets/client.rb +48 -1
- data/lib/aws-sdk-budgets/client_api.rb +40 -0
- data/lib/aws-sdk-budgets/types.rb +63 -0
- data/lib/aws-sdk-budgets.rb +1 -1
- metadata +2 -2
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: f36cfe3de3777c81f79195c250b4ae2530699a8674f2f5f913446b72a4615b84
         | 
| 4 | 
            +
              data.tar.gz: 1224f8ea9b2fe9c7548e5078badc960524b1e69ac4b363571efedd185e19208e
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 8bd29b188b7b6c39e0db0efea003303a19ee98e7c9405ede27cf3593778af17cc6f3cd54c9ec4bcfdc30c7fdb3bb995a9905a04c4845847cf80333332b27b7e0
         | 
| 7 | 
            +
              data.tar.gz: 1b3ba4844cfaafca9e43b59681e2fa86aeeff582a3cf2931d98dd66898d10657926d48122c827c93df4ca1226861b6e512c5909b2122e8bb9880a1823505037b
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    | @@ -1,6 +1,11 @@ | |
| 1 1 | 
             
            Unreleased Changes
         | 
| 2 2 | 
             
            ------------------
         | 
| 3 3 |  | 
| 4 | 
            +
            1.48.0 (2022-02-18)
         | 
| 5 | 
            +
            ------------------
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            * Feature - This change introduces DescribeBudgetNotificationsForAccount API which returns budget notifications for the specified account
         | 
| 8 | 
            +
             | 
| 4 9 | 
             
            1.47.0 (2022-02-16)
         | 
| 5 10 | 
             
            ------------------
         | 
| 6 11 |  | 
    
        data/VERSION
    CHANGED
    
    | @@ -1 +1 @@ | |
| 1 | 
            -
            1. | 
| 1 | 
            +
            1.48.0
         | 
| @@ -1185,6 +1185,53 @@ module Aws::Budgets | |
| 1185 1185 | 
             
                  req.send_request(options)
         | 
| 1186 1186 | 
             
                end
         | 
| 1187 1187 |  | 
| 1188 | 
            +
                # Lists the budget names and notifications that are associated with an
         | 
| 1189 | 
            +
                # account.
         | 
| 1190 | 
            +
                #
         | 
| 1191 | 
            +
                # @option params [required, String] :account_id
         | 
| 1192 | 
            +
                #   The account ID of the user. It's a 12-digit number.
         | 
| 1193 | 
            +
                #
         | 
| 1194 | 
            +
                # @option params [Integer] :max_results
         | 
| 1195 | 
            +
                #   An integer that shows how many budget name entries a paginated
         | 
| 1196 | 
            +
                #   response contains.
         | 
| 1197 | 
            +
                #
         | 
| 1198 | 
            +
                # @option params [String] :next_token
         | 
| 1199 | 
            +
                #   A generic string.
         | 
| 1200 | 
            +
                #
         | 
| 1201 | 
            +
                # @return [Types::DescribeBudgetNotificationsForAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
         | 
| 1202 | 
            +
                #
         | 
| 1203 | 
            +
                #   * {Types::DescribeBudgetNotificationsForAccountResponse#budget_notifications_for_account #budget_notifications_for_account} => Array<Types::BudgetNotificationsForAccount>
         | 
| 1204 | 
            +
                #   * {Types::DescribeBudgetNotificationsForAccountResponse#next_token #next_token} => String
         | 
| 1205 | 
            +
                #
         | 
| 1206 | 
            +
                # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
         | 
| 1207 | 
            +
                #
         | 
| 1208 | 
            +
                # @example Request syntax with placeholder values
         | 
| 1209 | 
            +
                #
         | 
| 1210 | 
            +
                #   resp = client.describe_budget_notifications_for_account({
         | 
| 1211 | 
            +
                #     account_id: "AccountId", # required
         | 
| 1212 | 
            +
                #     max_results: 1,
         | 
| 1213 | 
            +
                #     next_token: "GenericString",
         | 
| 1214 | 
            +
                #   })
         | 
| 1215 | 
            +
                #
         | 
| 1216 | 
            +
                # @example Response structure
         | 
| 1217 | 
            +
                #
         | 
| 1218 | 
            +
                #   resp.budget_notifications_for_account #=> Array
         | 
| 1219 | 
            +
                #   resp.budget_notifications_for_account[0].notifications #=> Array
         | 
| 1220 | 
            +
                #   resp.budget_notifications_for_account[0].notifications[0].notification_type #=> String, one of "ACTUAL", "FORECASTED"
         | 
| 1221 | 
            +
                #   resp.budget_notifications_for_account[0].notifications[0].comparison_operator #=> String, one of "GREATER_THAN", "LESS_THAN", "EQUAL_TO"
         | 
| 1222 | 
            +
                #   resp.budget_notifications_for_account[0].notifications[0].threshold #=> Float
         | 
| 1223 | 
            +
                #   resp.budget_notifications_for_account[0].notifications[0].threshold_type #=> String, one of "PERCENTAGE", "ABSOLUTE_VALUE"
         | 
| 1224 | 
            +
                #   resp.budget_notifications_for_account[0].notifications[0].notification_state #=> String, one of "OK", "ALARM"
         | 
| 1225 | 
            +
                #   resp.budget_notifications_for_account[0].budget_name #=> String
         | 
| 1226 | 
            +
                #   resp.next_token #=> String
         | 
| 1227 | 
            +
                #
         | 
| 1228 | 
            +
                # @overload describe_budget_notifications_for_account(params = {})
         | 
| 1229 | 
            +
                # @param [Hash] params ({})
         | 
| 1230 | 
            +
                def describe_budget_notifications_for_account(params = {}, options = {})
         | 
| 1231 | 
            +
                  req = build_request(:describe_budget_notifications_for_account, params)
         | 
| 1232 | 
            +
                  req.send_request(options)
         | 
| 1233 | 
            +
                end
         | 
| 1234 | 
            +
             | 
| 1188 1235 | 
             
                # Describes the history for `DAILY`, `MONTHLY`, and `QUARTERLY` budgets.
         | 
| 1189 1236 | 
             
                # Budget history isn't available for `ANNUAL` budgets.
         | 
| 1190 1237 | 
             
                #
         | 
| @@ -1833,7 +1880,7 @@ module Aws::Budgets | |
| 1833 1880 | 
             
                    params: params,
         | 
| 1834 1881 | 
             
                    config: config)
         | 
| 1835 1882 | 
             
                  context[:gem_name] = 'aws-sdk-budgets'
         | 
| 1836 | 
            -
                  context[:gem_version] = '1. | 
| 1883 | 
            +
                  context[:gem_version] = '1.48.0'
         | 
| 1837 1884 | 
             
                  Seahorse::Client::Request.new(handlers, context)
         | 
| 1838 1885 | 
             
                end
         | 
| 1839 1886 |  | 
| @@ -31,6 +31,8 @@ module Aws::Budgets | |
| 31 31 | 
             
                AutoAdjustType = Shapes::StringShape.new(name: 'AutoAdjustType')
         | 
| 32 32 | 
             
                Budget = Shapes::StructureShape.new(name: 'Budget')
         | 
| 33 33 | 
             
                BudgetName = Shapes::StringShape.new(name: 'BudgetName')
         | 
| 34 | 
            +
                BudgetNotificationsForAccount = Shapes::StructureShape.new(name: 'BudgetNotificationsForAccount')
         | 
| 35 | 
            +
                BudgetNotificationsForAccountList = Shapes::ListShape.new(name: 'BudgetNotificationsForAccountList')
         | 
| 34 36 | 
             
                BudgetPerformanceHistory = Shapes::StructureShape.new(name: 'BudgetPerformanceHistory')
         | 
| 35 37 | 
             
                BudgetType = Shapes::StringShape.new(name: 'BudgetType')
         | 
| 36 38 | 
             
                BudgetedAndActualAmounts = Shapes::StructureShape.new(name: 'BudgetedAndActualAmounts')
         | 
| @@ -66,6 +68,8 @@ module Aws::Budgets | |
| 66 68 | 
             
                DescribeBudgetActionsForAccountResponse = Shapes::StructureShape.new(name: 'DescribeBudgetActionsForAccountResponse')
         | 
| 67 69 | 
             
                DescribeBudgetActionsForBudgetRequest = Shapes::StructureShape.new(name: 'DescribeBudgetActionsForBudgetRequest')
         | 
| 68 70 | 
             
                DescribeBudgetActionsForBudgetResponse = Shapes::StructureShape.new(name: 'DescribeBudgetActionsForBudgetResponse')
         | 
| 71 | 
            +
                DescribeBudgetNotificationsForAccountRequest = Shapes::StructureShape.new(name: 'DescribeBudgetNotificationsForAccountRequest')
         | 
| 72 | 
            +
                DescribeBudgetNotificationsForAccountResponse = Shapes::StructureShape.new(name: 'DescribeBudgetNotificationsForAccountResponse')
         | 
| 69 73 | 
             
                DescribeBudgetPerformanceHistoryRequest = Shapes::StructureShape.new(name: 'DescribeBudgetPerformanceHistoryRequest')
         | 
| 70 74 | 
             
                DescribeBudgetPerformanceHistoryResponse = Shapes::StructureShape.new(name: 'DescribeBudgetPerformanceHistoryResponse')
         | 
| 71 75 | 
             
                DescribeBudgetRequest = Shapes::StructureShape.new(name: 'DescribeBudgetRequest')
         | 
| @@ -95,6 +99,7 @@ module Aws::Budgets | |
| 95 99 | 
             
                InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
         | 
| 96 100 | 
             
                InvalidParameterException = Shapes::StructureShape.new(name: 'InvalidParameterException')
         | 
| 97 101 | 
             
                MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
         | 
| 102 | 
            +
                MaxResultsBudgetNotifications = Shapes::IntegerShape.new(name: 'MaxResultsBudgetNotifications')
         | 
| 98 103 | 
             
                NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
         | 
| 99 104 | 
             
                Notification = Shapes::StructureShape.new(name: 'Notification')
         | 
| 100 105 | 
             
                NotificationState = Shapes::StringShape.new(name: 'NotificationState')
         | 
| @@ -189,6 +194,12 @@ module Aws::Budgets | |
| 189 194 | 
             
                Budget.add_member(:auto_adjust_data, Shapes::ShapeRef.new(shape: AutoAdjustData, location_name: "AutoAdjustData"))
         | 
| 190 195 | 
             
                Budget.struct_class = Types::Budget
         | 
| 191 196 |  | 
| 197 | 
            +
                BudgetNotificationsForAccount.add_member(:notifications, Shapes::ShapeRef.new(shape: Notifications, location_name: "Notifications"))
         | 
| 198 | 
            +
                BudgetNotificationsForAccount.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, location_name: "BudgetName"))
         | 
| 199 | 
            +
                BudgetNotificationsForAccount.struct_class = Types::BudgetNotificationsForAccount
         | 
| 200 | 
            +
             | 
| 201 | 
            +
                BudgetNotificationsForAccountList.member = Shapes::ShapeRef.new(shape: BudgetNotificationsForAccount)
         | 
| 202 | 
            +
             | 
| 192 203 | 
             
                BudgetPerformanceHistory.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, location_name: "BudgetName"))
         | 
| 193 204 | 
             
                BudgetPerformanceHistory.add_member(:budget_type, Shapes::ShapeRef.new(shape: BudgetType, location_name: "BudgetType"))
         | 
| 194 205 | 
             
                BudgetPerformanceHistory.add_member(:cost_filters, Shapes::ShapeRef.new(shape: CostFilters, location_name: "CostFilters"))
         | 
| @@ -345,6 +356,15 @@ module Aws::Budgets | |
| 345 356 | 
             
                DescribeBudgetActionsForBudgetResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: GenericString, location_name: "NextToken"))
         | 
| 346 357 | 
             
                DescribeBudgetActionsForBudgetResponse.struct_class = Types::DescribeBudgetActionsForBudgetResponse
         | 
| 347 358 |  | 
| 359 | 
            +
                DescribeBudgetNotificationsForAccountRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location_name: "AccountId"))
         | 
| 360 | 
            +
                DescribeBudgetNotificationsForAccountRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResultsBudgetNotifications, location_name: "MaxResults"))
         | 
| 361 | 
            +
                DescribeBudgetNotificationsForAccountRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: GenericString, location_name: "NextToken"))
         | 
| 362 | 
            +
                DescribeBudgetNotificationsForAccountRequest.struct_class = Types::DescribeBudgetNotificationsForAccountRequest
         | 
| 363 | 
            +
             | 
| 364 | 
            +
                DescribeBudgetNotificationsForAccountResponse.add_member(:budget_notifications_for_account, Shapes::ShapeRef.new(shape: BudgetNotificationsForAccountList, location_name: "BudgetNotificationsForAccount"))
         | 
| 365 | 
            +
                DescribeBudgetNotificationsForAccountResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: GenericString, location_name: "NextToken"))
         | 
| 366 | 
            +
                DescribeBudgetNotificationsForAccountResponse.struct_class = Types::DescribeBudgetNotificationsForAccountResponse
         | 
| 367 | 
            +
             | 
| 348 368 | 
             
                DescribeBudgetPerformanceHistoryRequest.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, required: true, location_name: "AccountId"))
         | 
| 349 369 | 
             
                DescribeBudgetPerformanceHistoryRequest.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, required: true, location_name: "BudgetName"))
         | 
| 350 370 | 
             
                DescribeBudgetPerformanceHistoryRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: TimePeriod, location_name: "TimePeriod"))
         | 
| @@ -732,6 +752,26 @@ module Aws::Budgets | |
| 732 752 | 
             
                    )
         | 
| 733 753 | 
             
                  end)
         | 
| 734 754 |  | 
| 755 | 
            +
                  api.add_operation(:describe_budget_notifications_for_account, Seahorse::Model::Operation.new.tap do |o|
         | 
| 756 | 
            +
                    o.name = "DescribeBudgetNotificationsForAccount"
         | 
| 757 | 
            +
                    o.http_method = "POST"
         | 
| 758 | 
            +
                    o.http_request_uri = "/"
         | 
| 759 | 
            +
                    o.input = Shapes::ShapeRef.new(shape: DescribeBudgetNotificationsForAccountRequest)
         | 
| 760 | 
            +
                    o.output = Shapes::ShapeRef.new(shape: DescribeBudgetNotificationsForAccountResponse)
         | 
| 761 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: InternalErrorException)
         | 
| 762 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: InvalidParameterException)
         | 
| 763 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
         | 
| 764 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
         | 
| 765 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException)
         | 
| 766 | 
            +
                    o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         | 
| 767 | 
            +
                    o[:pager] = Aws::Pager.new(
         | 
| 768 | 
            +
                      limit_key: "max_results",
         | 
| 769 | 
            +
                      tokens: {
         | 
| 770 | 
            +
                        "next_token" => "next_token"
         | 
| 771 | 
            +
                      }
         | 
| 772 | 
            +
                    )
         | 
| 773 | 
            +
                  end)
         | 
| 774 | 
            +
             | 
| 735 775 | 
             
                  api.add_operation(:describe_budget_performance_history, Seahorse::Model::Operation.new.tap do |o|
         | 
| 736 776 | 
             
                    o.name = "DescribeBudgetPerformanceHistory"
         | 
| 737 777 | 
             
                    o.http_method = "POST"
         | 
| @@ -402,6 +402,24 @@ module Aws::Budgets | |
| 402 402 | 
             
                  include Aws::Structure
         | 
| 403 403 | 
             
                end
         | 
| 404 404 |  | 
| 405 | 
            +
                # The budget name and associated notifications for an account.
         | 
| 406 | 
            +
                #
         | 
| 407 | 
            +
                # @!attribute [rw] notifications
         | 
| 408 | 
            +
                #   A list of notifications.
         | 
| 409 | 
            +
                #   @return [Array<Types::Notification>]
         | 
| 410 | 
            +
                #
         | 
| 411 | 
            +
                # @!attribute [rw] budget_name
         | 
| 412 | 
            +
                #   A string that represents the budget name. The ":" and "\\"
         | 
| 413 | 
            +
                #   characters aren't allowed.
         | 
| 414 | 
            +
                #   @return [String]
         | 
| 415 | 
            +
                #
         | 
| 416 | 
            +
                class BudgetNotificationsForAccount < Struct.new(
         | 
| 417 | 
            +
                  :notifications,
         | 
| 418 | 
            +
                  :budget_name)
         | 
| 419 | 
            +
                  SENSITIVE = []
         | 
| 420 | 
            +
                  include Aws::Structure
         | 
| 421 | 
            +
                end
         | 
| 422 | 
            +
             | 
| 405 423 | 
             
                # A history of the state of a budget at the end of the budget's
         | 
| 406 424 | 
             
                # specified time period.
         | 
| 407 425 | 
             
                #
         | 
| @@ -1398,6 +1416,51 @@ module Aws::Budgets | |
| 1398 1416 | 
             
                  include Aws::Structure
         | 
| 1399 1417 | 
             
                end
         | 
| 1400 1418 |  | 
| 1419 | 
            +
                # @note When making an API call, you may pass DescribeBudgetNotificationsForAccountRequest
         | 
| 1420 | 
            +
                #   data as a hash:
         | 
| 1421 | 
            +
                #
         | 
| 1422 | 
            +
                #       {
         | 
| 1423 | 
            +
                #         account_id: "AccountId", # required
         | 
| 1424 | 
            +
                #         max_results: 1,
         | 
| 1425 | 
            +
                #         next_token: "GenericString",
         | 
| 1426 | 
            +
                #       }
         | 
| 1427 | 
            +
                #
         | 
| 1428 | 
            +
                # @!attribute [rw] account_id
         | 
| 1429 | 
            +
                #   The account ID of the user. It's a 12-digit number.
         | 
| 1430 | 
            +
                #   @return [String]
         | 
| 1431 | 
            +
                #
         | 
| 1432 | 
            +
                # @!attribute [rw] max_results
         | 
| 1433 | 
            +
                #   An integer that shows how many budget name entries a paginated
         | 
| 1434 | 
            +
                #   response contains.
         | 
| 1435 | 
            +
                #   @return [Integer]
         | 
| 1436 | 
            +
                #
         | 
| 1437 | 
            +
                # @!attribute [rw] next_token
         | 
| 1438 | 
            +
                #   A generic string.
         | 
| 1439 | 
            +
                #   @return [String]
         | 
| 1440 | 
            +
                #
         | 
| 1441 | 
            +
                class DescribeBudgetNotificationsForAccountRequest < Struct.new(
         | 
| 1442 | 
            +
                  :account_id,
         | 
| 1443 | 
            +
                  :max_results,
         | 
| 1444 | 
            +
                  :next_token)
         | 
| 1445 | 
            +
                  SENSITIVE = []
         | 
| 1446 | 
            +
                  include Aws::Structure
         | 
| 1447 | 
            +
                end
         | 
| 1448 | 
            +
             | 
| 1449 | 
            +
                # @!attribute [rw] budget_notifications_for_account
         | 
| 1450 | 
            +
                #   A list of budget names and associated notifications for an account.
         | 
| 1451 | 
            +
                #   @return [Array<Types::BudgetNotificationsForAccount>]
         | 
| 1452 | 
            +
                #
         | 
| 1453 | 
            +
                # @!attribute [rw] next_token
         | 
| 1454 | 
            +
                #   A generic string.
         | 
| 1455 | 
            +
                #   @return [String]
         | 
| 1456 | 
            +
                #
         | 
| 1457 | 
            +
                class DescribeBudgetNotificationsForAccountResponse < Struct.new(
         | 
| 1458 | 
            +
                  :budget_notifications_for_account,
         | 
| 1459 | 
            +
                  :next_token)
         | 
| 1460 | 
            +
                  SENSITIVE = []
         | 
| 1461 | 
            +
                  include Aws::Structure
         | 
| 1462 | 
            +
                end
         | 
| 1463 | 
            +
             | 
| 1401 1464 | 
             
                # @note When making an API call, you may pass DescribeBudgetPerformanceHistoryRequest
         | 
| 1402 1465 | 
             
                #   data as a hash:
         | 
| 1403 1466 | 
             
                #
         | 
    
        data/lib/aws-sdk-budgets.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: aws-sdk-budgets
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 1. | 
| 4 | 
            +
              version: 1.48.0
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Amazon Web Services
         | 
| 8 8 | 
             
            autorequire: 
         | 
| 9 9 | 
             
            bindir: bin
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date: 2022-02- | 
| 11 | 
            +
            date: 2022-02-18 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: aws-sdk-core
         |