aws-sdk-cloudwatchevidently 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19f85dfeb3c1c5263519e6fc97c24fd897d5b6dd92652e6e3c93e59ddba58cd2
-  data.tar.gz: 2ed1fa3b479ceede3c804e22dacb46fc43a4653ed26670e2d9f7541626a4850f
+  metadata.gz: 6f3f58c6a280d62dbd2882697ce813b620de949d15a155b590b342baade0cb7b
+  data.tar.gz: 066babd43b4b8b6f7d8fe99117d3844a8c6a53766873f36425a1f3907c4425e9
 SHA512:
-  metadata.gz: f8c2d5a36c59745d40f7a635d5720cce2ccd01daa3b9f38354153d1cd43279db2bca45be17a5a536c691c70810632c7c255cb99a6572d31d775cb110b4240b79
-  data.tar.gz: fc634217a94e3bb3594528ba90fb90df605fac385e4428d77b77fa3e9ba86a15cfc2c591d461b6e0c8ae7074c33dba912bcd6b8b15a299605924b0e701d17ccf
+  metadata.gz: 1971f9f8bcb807c344947a3f772dea1596736763a59dfe6b4e6b6dfbdf3c4fa59076d029110f0fd4e91541d8774fce5185e55992880e9b6f785d9f9f5b61a616
+  data.tar.gz: 3e4872f524c53b4af5866be95324240d37d2c38628612d0999a610beb1c2c9e35d197ffd3c20f4c23d0b498871a3c655d13b88ab7c5c924a630024569dcd09f3

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.6.0 (2022-05-09)
+------------------
+
+* Feature - Add detail message inside GetExperimentResults API response to indicate experiment result availability
+
 1.5.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.6.0

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

@@ -1201,7 +1201,13 @@ module Aws::CloudWatchEvidently
       req.send_request(options)
     end
 
-    # Retrieves the results of a running or completed experiment.
+    # Retrieves the results of a running or completed experiment. No results
+    # are available until there have been 100 events for each variation and
+    # at least 10 minutes have passed since the start of the experiment.
+    #
+    # Experiment results are available up to 63 days after the start of the
+    # experiment. They are not available after that because of CloudWatch
+    # data retention policies.
     #
     # @option params [String] :base_stat
     #   The statistic used to calculate experiment results. Currently the only
@@ -1209,7 +1215,8 @@ module Aws::CloudWatchEvidently
     #   the statistic.
     #
     # @option params [Time,DateTime,Date,Integer,String] :end_time
-    #   The date and time that the experiment ended, if it is completed.
+    #   The date and time that the experiment ended, if it is completed. This
+    #   must be no longer than 30 days after the experiment start time.
     #
     # @option params [required, String] :experiment
     #   The name of the experiment to retrieve the results of.
@@ -1262,6 +1269,7 @@ module Aws::CloudWatchEvidently
     #
     # @return [Types::GetExperimentResultsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
+    #   * {Types::GetExperimentResultsResponse#details #details} => String
     #   * {Types::GetExperimentResultsResponse#reports #reports} => Array<Types::ExperimentReport>
     #   * {Types::GetExperimentResultsResponse#results_data #results_data} => Array<Types::ExperimentResultsData>
     #   * {Types::GetExperimentResultsResponse#timestamps #timestamps} => Array<Time>
@@ -1283,6 +1291,7 @@ module Aws::CloudWatchEvidently
     #
     # @example Response structure
     #
+    #   resp.details #=> String
     #   resp.reports #=> Array
     #   resp.reports[0].content #=> String
     #   resp.reports[0].metric_name #=> String
@@ -1823,7 +1832,8 @@ module Aws::CloudWatchEvidently
     # [1]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_CreateExperiment.html
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :analysis_complete_time
-    #   The date and time to end the experiment.
+    #   The date and time to end the experiment. This must be no more than 30
+    #   days after the experiment starts.
     #
     # @option params [required, String] :experiment
     #   The name of the experiment to start.
@@ -2597,7 +2607,7 @@ module Aws::CloudWatchEvidently
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-cloudwatchevidently'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -469,6 +469,7 @@ module Aws::CloudWatchEvidently
     GetExperimentResultsRequest.add_member(:treatment_names, Shapes::ShapeRef.new(shape: TreatmentNameList, required: true, location_name: "treatmentNames"))
     GetExperimentResultsRequest.struct_class = Types::GetExperimentResultsRequest
 
+    GetExperimentResultsResponse.add_member(:details, Shapes::ShapeRef.new(shape: String, location_name: "details"))
     GetExperimentResultsResponse.add_member(:reports, Shapes::ShapeRef.new(shape: ExperimentReportList, location_name: "reports"))
     GetExperimentResultsResponse.add_member(:results_data, Shapes::ShapeRef.new(shape: ExperimentResultsDataList, location_name: "resultsData"))
     GetExperimentResultsResponse.add_member(:timestamps, Shapes::ShapeRef.new(shape: TimestampList, location_name: "timestamps"))

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

@@ -1351,6 +1351,7 @@ module Aws::CloudWatchEvidently
     #
     # @!attribute [rw] end_time
     #   The date and time that the experiment ended, if it is completed.
+    #   This must be no longer than 30 days after the experiment start time.
     #   @return [Time]
     #
     # @!attribute [rw] experiment
@@ -1429,6 +1430,13 @@ module Aws::CloudWatchEvidently
       include Aws::Structure
     end
 
+    # @!attribute [rw] details
+    #   If the experiment doesn't yet have enough events to provide valid
+    #   results, this field is returned with the message `Not enough events
+    #   to generate results`. If there are enough events to provide valid
+    #   results, this field is not returned.
+    #   @return [String]
+    #
     # @!attribute [rw] reports
     #   An array of structures that include the reports that you requested.
     #   @return [Array<Types::ExperimentReport>]
@@ -1445,6 +1453,7 @@ module Aws::CloudWatchEvidently
     # @see http://docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/GetExperimentResultsResponse AWS API Documentation
     #
     class GetExperimentResultsResponse < Struct.new(
+      :details,
       :reports,
       :results_data,
       :timestamps)
@@ -2785,7 +2794,8 @@ module Aws::CloudWatchEvidently
     #       }
     #
     # @!attribute [rw] analysis_complete_time
-    #   The date and time to end the experiment.
+    #   The date and time to end the experiment. This must be no more than
+    #   30 days after the experiment starts.
     #   @return [Time]
     #
     # @!attribute [rw] experiment

data/lib/aws-sdk-cloudwatchevidently.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-cloudwatchevidently/customizations'
 # @!group service
 module Aws::CloudWatchEvidently
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-cloudwatchevidently
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core