aws-sdk-costexplorer 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67310da94c4e49f764bef9d44da7db653a9ca799
-  data.tar.gz: 8499be35371e3b9c811968451370fcc1a1f9a167
+  metadata.gz: eb2ad7048395e470aba1a6f2214d17230019a07b
+  data.tar.gz: 0fba670ecb4e492e92132d908d0e03cef07208ed
 SHA512:
-  metadata.gz: 600652caeb2151aa7d892d005312e574ca593acb41ca5433dea08e5643b5e4d3e4704a07e39a58f49932118980404ba051b8eb44225177755b081293e9db25db
-  data.tar.gz: 026e9bbdcd974a00b4cde2cb3e87b6c37c2cb7e7ec9297a6e442d7a62c96ae2cabe1f1cbfb8d1899444e14f858fc9e3f2e51dd6ea12b5e7bf6102785fb328e9f
+  metadata.gz: 2589fc02bc24f46270f771a5479153050e4eef4dd21ba58a195839bb63095c07e89fe1ba2b3c8f68e4a78f431216176a946edd466b4cdf0d4cf023bb717665d3
+  data.tar.gz: 9e95919dc6f4a670603af07d4ec700a682b9fb9bbd31666d6e34daeb89297b25f9fcc6acf49149f70477435b54791a132f09ed256f2de4c2bc54cac8b529951e

data/lib/aws-sdk-costexplorer.rb

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

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

@@ -15,6 +15,7 @@ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
 require 'aws-sdk-core/plugins/retry_errors.rb'
 require 'aws-sdk-core/plugins/global_configuration.rb'
 require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/endpoint_discovery.rb'
 require 'aws-sdk-core/plugins/response_paging.rb'
 require 'aws-sdk-core/plugins/stub_responses.rb'
 require 'aws-sdk-core/plugins/idempotency_token.rb'
@@ -45,6 +46,7 @@ module Aws::CostExplorer
     add_plugin(Aws::Plugins::RetryErrors)
     add_plugin(Aws::Plugins::GlobalConfiguration)
     add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::EndpointDiscovery)
     add_plugin(Aws::Plugins::ResponsePaging)
     add_plugin(Aws::Plugins::StubResponses)
     add_plugin(Aws::Plugins::IdempotencyToken)
@@ -98,6 +100,10 @@ module Aws::CostExplorer
     #
     #   @option options [String] :access_key_id
     #
+    #   @option options [Boolean] :active_endpoint_cache (false)
+    #     When set to `true`, a thread polling for endpoints will be running in
+    #     the background every 60 secs (default). Defaults to `false`.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -123,6 +129,21 @@ module Aws::CostExplorer
     #     option. You should only configure an `:endpoint` when connecting
     #     to test endpoints. This should be avalid HTTP(S) URI.
     #
+    #   @option options [Integer] :endpoint_cache_max_entries (1000)
+    #     Used for the maximum size limit of the LRU cache storing endpoints data
+    #     for endpoint discovery enabled operations. Defaults to 1000.
+    #
+    #   @option options [Integer] :endpoint_cache_max_threads (10)
+    #     Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
+    #
+    #   @option options [Integer] :endpoint_cache_poll_interval (60)
+    #     When :endpoint_discovery and :active_endpoint_cache is enabled,
+    #     Use this option to config the time interval in seconds for making
+    #     requests fetching endpoints information. Defaults to 60 sec.
+    #
+    #   @option options [Boolean] :endpoint_discovery (false)
+    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
     #
@@ -336,6 +357,110 @@ module Aws::CostExplorer
       req.send_request(options)
     end
 
+    # Retrieves a forecast for how much Amazon Web Services predicts that
+    # you will spend over the forecast time period that you select, based on
+    # your past costs.
+    #
+    # @option params [required, Types::DateInterval] :time_period
+    #   The period of time that you want the forecast to cover.
+    #
+    # @option params [required, String] :metric
+    #   Which metric Cost Explorer uses to create your forecast. For more
+    #   information about blended and unblended rates, see [Why does the
+    #   "blended" annotation appear on some line items in my bill?][1].
+    #
+    #   Valid values for a `GetCostForecast` call are the following:
+    #
+    #   * AmortizedCost
+    #
+    #   * BlendedCost
+    #
+    #   * NetAmortizedCost
+    #
+    #   * NetUnblendedCost
+    #
+    #   * UnblendedCost
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/
+    #
+    # @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.
+    #
+    # @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::GetCostForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetCostForecastResponse#total #total} => Types::MetricValue
+    #   * {Types::GetCostForecastResponse#forecast_results_by_time #forecast_results_by_time} => Array<Types::ForecastResult>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_cost_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/GetCostForecast AWS API Documentation
+    #
+    # @overload get_cost_forecast(params = {})
+    # @param [Hash] params ({})
+    def get_cost_forecast(params = {}, options = {})
+      req = build_request(:get_cost_forecast, params)
+      req.send_request(options)
+    end
+
     # Retrieves all available filter values for a specified filter over a
     # period of time. You can search the dimension values for an arbitrary
     # string.
@@ -1061,7 +1186,7 @@ module Aws::CostExplorer
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-costexplorer'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -39,10 +39,14 @@ module Aws::CostExplorer
     Estimated = Shapes::BooleanShape.new(name: 'Estimated')
     Expression = Shapes::StructureShape.new(name: 'Expression')
     Expressions = Shapes::ListShape.new(name: 'Expressions')
+    ForecastResult = Shapes::StructureShape.new(name: 'ForecastResult')
+    ForecastResultsByTime = Shapes::ListShape.new(name: 'ForecastResultsByTime')
     GenericBoolean = Shapes::BooleanShape.new(name: 'GenericBoolean')
     GenericString = Shapes::StringShape.new(name: 'GenericString')
     GetCostAndUsageRequest = Shapes::StructureShape.new(name: 'GetCostAndUsageRequest')
     GetCostAndUsageResponse = Shapes::StructureShape.new(name: 'GetCostAndUsageResponse')
+    GetCostForecastRequest = Shapes::StructureShape.new(name: 'GetCostForecastRequest')
+    GetCostForecastResponse = Shapes::StructureShape.new(name: 'GetCostForecastResponse')
     GetDimensionValuesRequest = Shapes::StructureShape.new(name: 'GetDimensionValuesRequest')
     GetDimensionValuesResponse = Shapes::StructureShape.new(name: 'GetDimensionValuesResponse')
     GetReservationCoverageRequest = Shapes::StructureShape.new(name: 'GetReservationCoverageRequest')
@@ -66,6 +70,7 @@ module Aws::CostExplorer
     Keys = Shapes::ListShape.new(name: 'Keys')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
     LookbackPeriodInDays = Shapes::StringShape.new(name: 'LookbackPeriodInDays')
+    Metric = Shapes::StringShape.new(name: 'Metric')
     MetricAmount = Shapes::StringShape.new(name: 'MetricAmount')
     MetricName = Shapes::StringShape.new(name: 'MetricName')
     MetricNames = Shapes::ListShape.new(name: 'MetricNames')
@@ -80,6 +85,7 @@ module Aws::CostExplorer
     OnDemandHours = Shapes::StringShape.new(name: 'OnDemandHours')
     PageSize = Shapes::IntegerShape.new(name: 'PageSize')
     PaymentOption = Shapes::StringShape.new(name: 'PaymentOption')
+    PredictionIntervalLevel = Shapes::IntegerShape.new(name: 'PredictionIntervalLevel')
     PurchasedHours = Shapes::StringShape.new(name: 'PurchasedHours')
     RDSInstanceDetails = Shapes::StructureShape.new(name: 'RDSInstanceDetails')
     RedshiftInstanceDetails = Shapes::StructureShape.new(name: 'RedshiftInstanceDetails')
@@ -188,6 +194,14 @@ module Aws::CostExplorer
 
     Expressions.member = Shapes::ShapeRef.new(shape: Expression)
 
+    ForecastResult.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, location_name: "TimePeriod"))
+    ForecastResult.add_member(:mean_value, Shapes::ShapeRef.new(shape: GenericString, location_name: "MeanValue"))
+    ForecastResult.add_member(:prediction_interval_lower_bound, Shapes::ShapeRef.new(shape: GenericString, location_name: "PredictionIntervalLowerBound"))
+    ForecastResult.add_member(:prediction_interval_upper_bound, Shapes::ShapeRef.new(shape: GenericString, location_name: "PredictionIntervalUpperBound"))
+    ForecastResult.struct_class = Types::ForecastResult
+
+    ForecastResultsByTime.member = Shapes::ShapeRef.new(shape: ForecastResult)
+
     GetCostAndUsageRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, location_name: "TimePeriod"))
     GetCostAndUsageRequest.add_member(:granularity, Shapes::ShapeRef.new(shape: Granularity, location_name: "Granularity"))
     GetCostAndUsageRequest.add_member(:filter, Shapes::ShapeRef.new(shape: Expression, location_name: "Filter"))
@@ -201,6 +215,17 @@ module Aws::CostExplorer
     GetCostAndUsageResponse.add_member(:results_by_time, Shapes::ShapeRef.new(shape: ResultsByTime, location_name: "ResultsByTime"))
     GetCostAndUsageResponse.struct_class = Types::GetCostAndUsageResponse
 
+    GetCostForecastRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, required: true, location_name: "TimePeriod"))
+    GetCostForecastRequest.add_member(:metric, Shapes::ShapeRef.new(shape: Metric, required: true, location_name: "Metric"))
+    GetCostForecastRequest.add_member(:granularity, Shapes::ShapeRef.new(shape: Granularity, required: true, location_name: "Granularity"))
+    GetCostForecastRequest.add_member(:filter, Shapes::ShapeRef.new(shape: Expression, location_name: "Filter"))
+    GetCostForecastRequest.add_member(:prediction_interval_level, Shapes::ShapeRef.new(shape: PredictionIntervalLevel, location_name: "PredictionIntervalLevel"))
+    GetCostForecastRequest.struct_class = Types::GetCostForecastRequest
+
+    GetCostForecastResponse.add_member(:total, Shapes::ShapeRef.new(shape: MetricValue, location_name: "Total"))
+    GetCostForecastResponse.add_member(:forecast_results_by_time, Shapes::ShapeRef.new(shape: ForecastResultsByTime, location_name: "ForecastResultsByTime"))
+    GetCostForecastResponse.struct_class = Types::GetCostForecastResponse
+
     GetDimensionValuesRequest.add_member(:search_string, Shapes::ShapeRef.new(shape: SearchString, location_name: "SearchString"))
     GetDimensionValuesRequest.add_member(:time_period, Shapes::ShapeRef.new(shape: DateInterval, required: true, location_name: "TimePeriod"))
     GetDimensionValuesRequest.add_member(:dimension, Shapes::ShapeRef.new(shape: Dimension, required: true, location_name: "Dimension"))
@@ -442,6 +467,16 @@ module Aws::CostExplorer
         o.errors << Shapes::ShapeRef.new(shape: RequestChangedException)
       end)
 
+      api.add_operation(:get_cost_forecast, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetCostForecast"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetCostForecastRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetCostForecastResponse)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: DataUnavailableException)
+      end)
+
       api.add_operation(:get_dimension_values, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetDimensionValues"
         o.http_method = "POST"

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

@@ -454,6 +454,34 @@ module Aws::CostExplorer
       include Aws::Structure
     end
 
+    # The forecast created for your query.
+    #
+    # @!attribute [rw] time_period
+    #   The period of time that the forecast covers.
+    #   @return [Types::DateInterval]
+    #
+    # @!attribute [rw] mean_value
+    #   The mean value of the forecast.
+    #   @return [String]
+    #
+    # @!attribute [rw] prediction_interval_lower_bound
+    #   The lower limit for the prediction interval.
+    #   @return [String]
+    #
+    # @!attribute [rw] prediction_interval_upper_bound
+    #   The upper limit for the prediction interval.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/ce-2017-10-25/ForecastResult AWS API Documentation
+    #
+    class ForecastResult < Struct.new(
+      :time_period,
+      :mean_value,
+      :prediction_interval_lower_bound,
+      :prediction_interval_upper_bound)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetCostAndUsageRequest
     #   data as a hash:
     #
@@ -602,6 +630,117 @@ module Aws::CostExplorer
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetCostForecastRequest
+    #   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 period of time that you want the forecast to cover.
+    #   @return [Types::DateInterval]
+    #
+    # @!attribute [rw] metric
+    #   Which metric Cost Explorer uses to create your forecast. For more
+    #   information about blended and unblended rates, see [Why does the
+    #   "blended" annotation appear on some line items in my bill?][1].
+    #
+    #   Valid values for a `GetCostForecast` call are the following:
+    #
+    #   * AmortizedCost
+    #
+    #   * BlendedCost
+    #
+    #   * NetAmortizedCost
+    #
+    #   * NetUnblendedCost
+    #
+    #   * UnblendedCost
+    #
+    #
+    #
+    #   [1]: https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/
+    #   @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.
+    #   @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/GetCostForecastRequest AWS API Documentation
+    #
+    class GetCostForecastRequest < Struct.new(
+      :time_period,
+      :metric,
+      :granularity,
+      :filter,
+      :prediction_interval_level)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] total
+    #   How much you are forecasted to spend over the forecast period, in
+    #   `USD`.
+    #   @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/GetCostForecastResponse AWS API Documentation
+    #
+    class GetCostForecastResponse < Struct.new(
+      :total,
+      :forecast_results_by_time)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetDimensionValuesRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-costexplorer
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.26.0
+        version: 3.37.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.26.0
+        version: 3.37.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement