aws-sdk-costexplorer 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9c9fd9afbc201ac00c1603a73a0b52b053111d2
-  data.tar.gz: d04a8b4f144ee4ad8881a6aa10ba6fa81e33b219
+  metadata.gz: e16f1050824d5d201ed443d6c3f4124856bafde4
+  data.tar.gz: 7386405acc2d198edf0ab04777bb3c4b56c1185e
 SHA512:
-  metadata.gz: dc9c0ac8e95172ecaebfa1ad9679ff5381f69670f69683671213423dc9abe9cc86717e977f8680ddbc9c5d451bb27d725cb974a4cc5edc7b054d95b497e97c63
-  data.tar.gz: 1da613748501dcb8949a8aeb5cc9f691a788547e5c8e9202d0112109ff8ceefb488939656b19c1fd3bd45a19f081f643e83145f6b982fe388dc8580df4d99814
+  metadata.gz: 41ab766d9983ce7297ef14018da0cef1f71fc2d0e9685736db96966edf2de6b80f24931a2652c6a06dc6c09e33ceab457489664e1fa58923af8ed4184715e29b
+  data.tar.gz: 01a52f60d50e672872a3ccd25fc3041787de4b0eb8f40636a5da9fcddbc0dd429b98f09d6c221d8c8fd6120b256c22f582e93455cb194f1a31d443743a293b97

data/lib/aws-sdk-costexplorer.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-costexplorer/customizations'
 # @service
 module Aws::CostExplorer
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.27.0'
 
 end

data/lib/aws-sdk-costexplorer/client.rb

@@ -434,15 +434,15 @@ module Aws::CostExplorer
     #
     #   Valid values for a `GetCostForecast` call are the following:
     #
-    #   * AmortizedCost
+    #   * AMORTIZED\_COST
     #
-    #   * BlendedCost
+    #   * BLENDED\_COST
     #
-    #   * NetAmortizedCost
+    #   * NET\_AMORTIZED\_COST
     #
-    #   * NetUnblendedCost
+    #   * NET\_UNBLENDED\_COST
     #
-    #   * UnblendedCost
+    #   * UNBLENDED\_COST
     #
     #
     #
@@ -1287,6 +1287,106 @@ module Aws::CostExplorer
       req.send_request(options)
     end
 
+    # Retrieves a forecast for how much Amazon Web Services predicts that
+    # you will use over the forecast time period that you select, based on
+    # your past usage.
+    #
+    # @option params [required, Types::DateInterval] :time_period
+    #   The start and end dates of the period that you want to retrieve usage
+    #   forecast for. The start date is inclusive, but the end date is
+    #   exclusive. For example, if `start` is `2017-01-01` and `end` is
+    #   `2017-05-01`, then the cost and usage data is retrieved from
+    #   `2017-01-01` up to and including `2017-04-30` but not including
+    #   `2017-05-01`.
+    #
+    # @option params [required, String] :metric
+    #   Which metric Cost Explorer uses to create your forecast.
+    #
+    #   Valid values for a `GetUsageForecast` call are the following:
+    #
+    #   * USAGE\_QUANTITY
+    #
+    #   * NORMALIZED\_USAGE\_AMOUNT
+    #
+    # @option params [required, String] :granularity
+    #   How granular you want the forecast to be. You can get 3 months of
+    #   `DAILY` forecasts or 12 months of `MONTHLY` forecasts.
+    #
+    #   The `GetUsageForecast` operation supports only `DAILY` and `MONTHLY`
+    #   granularities.
+    #
+    # @option params [Types::Expression] :filter
+    #   The filters that you want to use to filter your forecast. Cost
+    #   Explorer API supports all of the Cost Explorer filters.
+    #
+    # @option params [Integer] :prediction_interval_level
+    #   Cost Explorer always returns the mean forecast as a single point. You
+    #   can request a prediction interval around the mean by specifying a
+    #   confidence level. The higher the confidence level, the more confident
+    #   Cost Explorer is about the actual value falling in the prediction
+    #   interval. Higher confidence levels result in wider prediction
+    #   intervals.
+    #
+    # @return [Types::GetUsageForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetUsageForecastResponse#total #total} => Types::MetricValue
+    #   * {Types::GetUsageForecastResponse#forecast_results_by_time #forecast_results_by_time} => Array<Types::ForecastResult>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_usage_forecast({
+    #     time_period: { # required
+    #       start: "YearMonthDay", # required
+    #       end: "YearMonthDay", # required
+    #     },
+    #     metric: "BLENDED_COST", # required, accepts BLENDED_COST, UNBLENDED_COST, AMORTIZED_COST, NET_UNBLENDED_COST, NET_AMORTIZED_COST, USAGE_QUANTITY, NORMALIZED_USAGE_AMOUNT
+    #     granularity: "DAILY", # required, accepts DAILY, MONTHLY, HOURLY
+    #     filter: {
+    #       or: [
+    #         {
+    #           # recursive Expression
+    #         },
+    #       ],
+    #       and: [
+    #         {
+    #           # recursive Expression
+    #         },
+    #       ],
+    #       not: {
+    #         # recursive Expression
+    #       },
+    #       dimensions: {
+    #         key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID
+    #         values: ["Value"],
+    #       },
+    #       tags: {
+    #         key: "TagKey",
+    #         values: ["Value"],
+    #       },
+    #     },
+    #     prediction_interval_level: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.total.amount #=> String
+    #   resp.total.unit #=> String
+    #   resp.forecast_results_by_time #=> Array
+    #   resp.forecast_results_by_time[0].time_period.start #=> String
+    #   resp.forecast_results_by_time[0].time_period.end #=> String
+    #   resp.forecast_results_by_time[0].mean_value #=> String
+    #   resp.forecast_results_by_time[0].prediction_interval_lower_bound #=> String
+    #   resp.forecast_results_by_time[0].prediction_interval_upper_bound #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetUsageForecast AWS API Documentation
+    #
+    # @overload get_usage_forecast(params = {})
+    # @param [Hash] params ({})
+    def get_usage_forecast(params = {}, options = {})
+      req = build_request(:get_usage_forecast, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -1300,7 +1400,7 @@ module Aws::CostExplorer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-costexplorer'
-      context[:gem_version] = '1.26.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-costexplorer/client_api.rb

@@ -60,6 +60,8 @@ module Aws::CostExplorer
     GetReservationUtilizationResponse = Shapes::StructureShape.new(name: 'GetReservationUtilizationResponse')
     GetTagsRequest = Shapes::StructureShape.new(name: 'GetTagsRequest')
     GetTagsResponse = Shapes::StructureShape.new(name: 'GetTagsResponse')
+    GetUsageForecastRequest = Shapes::StructureShape.new(name: 'GetUsageForecastRequest')
+    GetUsageForecastResponse = Shapes::StructureShape.new(name: 'GetUsageForecastResponse')
     Granularity = Shapes::StringShape.new(name: 'Granularity')
     Group = Shapes::StructureShape.new(name: 'Group')
     GroupDefinition = Shapes::StructureShape.new(name: 'GroupDefinition')
@@ -125,6 +127,7 @@ module Aws::CostExplorer
     TotalPotentialRISavings = Shapes::StringShape.new(name: 'TotalPotentialRISavings')
     TotalRunningHours = Shapes::StringShape.new(name: 'TotalRunningHours')
     TotalRunningNormalizedUnits = Shapes::StringShape.new(name: 'TotalRunningNormalizedUnits')
+    UnresolvableUsageUnitException = Shapes::StructureShape.new(name: 'UnresolvableUsageUnitException')
     UnusedHours = Shapes::StringShape.new(name: 'UnusedHours')
     UnusedUnits = Shapes::StringShape.new(name: 'UnusedUnits')
     UtilizationByTime = Shapes::StructureShape.new(name: 'UtilizationByTime')
@@ -320,6 +323,17 @@ module Aws::CostExplorer
     GetTagsResponse.add_member(:total_size, Shapes::ShapeRef.new(shape: PageSize, required: true, location_name: "TotalSize"))
     GetTagsResponse.struct_class = Types::GetTagsResponse
 
+    GetUsageForecastRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, required: true, location_name: "TimePeriod"))
+    GetUsageForecastRequest.add_member(:metric, Shapes::ShapeRef.new(shape: Metric, required: true, location_name: "Metric"))
+    GetUsageForecastRequest.add_member(:granularity, Shapes::ShapeRef.new(shape: Granularity, required: true, location_name: "Granularity"))
+    GetUsageForecastRequest.add_member(:filter, Shapes::ShapeRef.new(shape: Expression, location_name: "Filter"))
+    GetUsageForecastRequest.add_member(:prediction_interval_level, Shapes::ShapeRef.new(shape: PredictionIntervalLevel, location_name: "PredictionIntervalLevel"))
+    GetUsageForecastRequest.struct_class = Types::GetUsageForecastRequest
+
+    GetUsageForecastResponse.add_member(:total, Shapes::ShapeRef.new(shape: MetricValue, location_name: "Total"))
+    GetUsageForecastResponse.add_member(:forecast_results_by_time, Shapes::ShapeRef.new(shape: ForecastResultsByTime, location_name: "ForecastResultsByTime"))
+    GetUsageForecastResponse.struct_class = Types::GetUsageForecastResponse
+
     Group.add_member(:keys, Shapes::ShapeRef.new(shape: Keys, location_name: "Keys"))
     Group.add_member(:metrics, Shapes::ShapeRef.new(shape: Metrics, location_name: "Metrics"))
     Group.struct_class = Types::Group
@@ -467,6 +481,9 @@ module Aws::CostExplorer
     TagValues.add_member(:values, Shapes::ShapeRef.new(shape: Values, location_name: "Values"))
     TagValues.struct_class = Types::TagValues
 
+    UnresolvableUsageUnitException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
+    UnresolvableUsageUnitException.struct_class = Types::UnresolvableUsageUnitException
+
     UtilizationByTime.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, location_name: "TimePeriod"))
     UtilizationByTime.add_member(:groups, Shapes::ShapeRef.new(shape: ReservationUtilizationGroups, location_name: "Groups"))
     UtilizationByTime.add_member(:total, Shapes::ShapeRef.new(shape: ReservationAggregates, location_name: "Total"))
@@ -577,6 +594,17 @@ module Aws::CostExplorer
         o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
         o.errors << Shapes::ShapeRef.new(shape: RequestChangedException)
       end)
+
+      api.add_operation(:get_usage_forecast, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetUsageForecast"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetUsageForecastRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetUsageForecastResponse)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: DataUnavailableException)
+        o.errors << Shapes::ShapeRef.new(shape: UnresolvableUsageUnitException)
+      end)
     end
 
   end

data/lib/aws-sdk-costexplorer/errors.rb

@@ -90,5 +90,21 @@ module Aws::CostExplorer
 
     end
 
+    class UnresolvableUsageUnitException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::CostExplorer::Types::UnresolvableUsageUnitException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+    end
+
   end
 end

data/lib/aws-sdk-costexplorer/types.rb

@@ -774,15 +774,15 @@ module Aws::CostExplorer
     #
     #   Valid values for a `GetCostForecast` call are the following:
     #
-    #   * AmortizedCost
+    #   * AMORTIZED\_COST
     #
-    #   * BlendedCost
+    #   * BLENDED\_COST
     #
-    #   * NetAmortizedCost
+    #   * NET\_AMORTIZED\_COST
     #
-    #   * NetUnblendedCost
+    #   * NET\_UNBLENDED\_COST
     #
-    #   * UnblendedCost
+    #   * UNBLENDED\_COST
     #
     #
     #
@@ -1576,6 +1576,112 @@ module Aws::CostExplorer
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetUsageForecastRequest
+    #   data as a hash:
+    #
+    #       {
+    #         time_period: { # required
+    #           start: "YearMonthDay", # required
+    #           end: "YearMonthDay", # required
+    #         },
+    #         metric: "BLENDED_COST", # required, accepts BLENDED_COST, UNBLENDED_COST, AMORTIZED_COST, NET_UNBLENDED_COST, NET_AMORTIZED_COST, USAGE_QUANTITY, NORMALIZED_USAGE_AMOUNT
+    #         granularity: "DAILY", # required, accepts DAILY, MONTHLY, HOURLY
+    #         filter: {
+    #           or: [
+    #             {
+    #               # recursive Expression
+    #             },
+    #           ],
+    #           and: [
+    #             {
+    #               # recursive Expression
+    #             },
+    #           ],
+    #           not: {
+    #             # recursive Expression
+    #           },
+    #           dimensions: {
+    #             key: "AZ", # accepts AZ, INSTANCE_TYPE, LINKED_ACCOUNT, OPERATION, PURCHASE_TYPE, REGION, SERVICE, USAGE_TYPE, USAGE_TYPE_GROUP, RECORD_TYPE, OPERATING_SYSTEM, TENANCY, SCOPE, PLATFORM, SUBSCRIPTION_ID, LEGAL_ENTITY_NAME, DEPLOYMENT_OPTION, DATABASE_ENGINE, CACHE_ENGINE, INSTANCE_TYPE_FAMILY, BILLING_ENTITY, RESERVATION_ID
+    #             values: ["Value"],
+    #           },
+    #           tags: {
+    #             key: "TagKey",
+    #             values: ["Value"],
+    #           },
+    #         },
+    #         prediction_interval_level: 1,
+    #       }
+    #
+    # @!attribute [rw] time_period
+    #   The start and end dates of the period that you want to retrieve
+    #   usage forecast for. The start date is inclusive, but the end date is
+    #   exclusive. For example, if `start` is `2017-01-01` and `end` is
+    #   `2017-05-01`, then the cost and usage data is retrieved from
+    #   `2017-01-01` up to and including `2017-04-30` but not including
+    #   `2017-05-01`.
+    #   @return [Types::DateInterval]
+    #
+    # @!attribute [rw] metric
+    #   Which metric Cost Explorer uses to create your forecast.
+    #
+    #   Valid values for a `GetUsageForecast` call are the following:
+    #
+    #   * USAGE\_QUANTITY
+    #
+    #   * NORMALIZED\_USAGE\_AMOUNT
+    #   @return [String]
+    #
+    # @!attribute [rw] granularity
+    #   How granular you want the forecast to be. You can get 3 months of
+    #   `DAILY` forecasts or 12 months of `MONTHLY` forecasts.
+    #
+    #   The `GetUsageForecast` operation supports only `DAILY` and `MONTHLY`
+    #   granularities.
+    #   @return [String]
+    #
+    # @!attribute [rw] filter
+    #   The filters that you want to use to filter your forecast. Cost
+    #   Explorer API supports all of the Cost Explorer filters.
+    #   @return [Types::Expression]
+    #
+    # @!attribute [rw] prediction_interval_level
+    #   Cost Explorer always returns the mean forecast as a single point.
+    #   You can request a prediction interval around the mean by specifying
+    #   a confidence level. The higher the confidence level, the more
+    #   confident Cost Explorer is about the actual value falling in the
+    #   prediction interval. Higher confidence levels result in wider
+    #   prediction intervals.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetUsageForecastRequest AWS API Documentation
+    #
+    class GetUsageForecastRequest < Struct.new(
+      :time_period,
+      :metric,
+      :granularity,
+      :filter,
+      :prediction_interval_level)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] total
+    #   How much you're forecasted to use over the forecast period.
+    #   @return [Types::MetricValue]
+    #
+    # @!attribute [rw] forecast_results_by_time
+    #   The forecasts for your query, in order. For `DAILY` forecasts, this
+    #   is a list of days. For `MONTHLY` forecasts, this is a list of
+    #   months.
+    #   @return [Array<Types::ForecastResult>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/GetUsageForecastResponse AWS API Documentation
+    #
+    class GetUsageForecastResponse < Struct.new(
+      :total,
+      :forecast_results_by_time)
+      include Aws::Structure
+    end
+
     # One level of grouped data in the results.
     #
     # @!attribute [rw] keys
@@ -2232,6 +2338,20 @@ module Aws::CostExplorer
       include Aws::Structure
     end
 
+    # Cost Explorer was unable to identify the usage unit. Provide
+    # `UsageType/UsageTypeGroup` filter selections that contain matching
+    # units, for example: `hours`.(
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/UnresolvableUsageUnitException AWS API Documentation
+    #
+    class UnresolvableUsageUnitException < Struct.new(
+      :message)
+      include Aws::Structure
+    end
+
     # The amount of utilization, in hours.
     #
     # @!attribute [rw] time_period

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-costexplorer
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core