aws-sdk-cloudwatchevidently 1.9.0 → 1.11.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -23,20 +23,6 @@ module Aws::CloudWatchEvidently
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
- # @note When making an API call, you may pass BatchEvaluateFeatureRequest
27
- # data as a hash:
28
- #
29
- # {
30
- # project: "ProjectRef", # required
31
- # requests: [ # required
32
- # {
33
- # entity_id: "EntityId", # required
34
- # evaluation_context: "JsonValue",
35
- # feature: "FeatureName", # required
36
- # },
37
- # ],
38
- # }
39
- #
40
26
  # @!attribute [rw] project
41
27
  # The name or ARN of the project that contains the feature being
42
28
  # evaluated.
@@ -88,13 +74,6 @@ module Aws::CloudWatchEvidently
88
74
  # A structure containing the CloudWatch Logs log group where the project
89
75
  # stores evaluation events.
90
76
  #
91
- # @note When making an API call, you may pass CloudWatchLogsDestinationConfig
92
- # data as a hash:
93
- #
94
- # {
95
- # log_group: "CwLogGroupSafeName",
96
- # }
97
- #
98
77
  # @!attribute [rw] log_group
99
78
  # The name of the log group where the project stores evaluation
100
79
  # events.
@@ -132,47 +111,6 @@ module Aws::CloudWatchEvidently
132
111
  include Aws::Structure
133
112
  end
134
113
 
135
- # @note When making an API call, you may pass CreateExperimentRequest
136
- # data as a hash:
137
- #
138
- # {
139
- # description: "Description",
140
- # metric_goals: [ # required
141
- # {
142
- # desired_change: "INCREASE", # accepts INCREASE, DECREASE
143
- # metric_definition: { # required
144
- # entity_id_key: "JsonPath", # required
145
- # event_pattern: "MetricDefinitionConfigEventPatternString",
146
- # name: "CwDimensionSafeName", # required
147
- # unit_label: "MetricUnitLabel",
148
- # value_key: "JsonPath", # required
149
- # },
150
- # },
151
- # ],
152
- # name: "ExperimentName", # required
153
- # online_ab_config: {
154
- # control_treatment_name: "TreatmentName",
155
- # treatment_weights: {
156
- # "TreatmentName" => 1,
157
- # },
158
- # },
159
- # project: "ProjectRef", # required
160
- # randomization_salt: "RandomizationSalt",
161
- # sampling_rate: 1,
162
- # segment: "SegmentRef",
163
- # tags: {
164
- # "TagKey" => "TagValue",
165
- # },
166
- # treatments: [ # required
167
- # {
168
- # description: "Description",
169
- # feature: "FeatureName", # required
170
- # name: "TreatmentName", # required
171
- # variation: "VariationName", # required
172
- # },
173
- # ],
174
- # }
175
- #
176
114
  # @!attribute [rw] description
177
115
  # An optional description of the experiment.
178
116
  # @return [String]
@@ -234,7 +172,14 @@ module Aws::CloudWatchEvidently
234
172
  # Tags don't have any semantic meaning to Amazon Web Services and are
235
173
  # interpreted strictly as strings of characters.
236
174
  #
237
- # <p>You can associate as many as 50 tags with an experiment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
175
+ # You can associate as many as 50 tags with an experiment.
176
+ #
177
+ # For more information, see [Tagging Amazon Web Services
178
+ # resources][1].
179
+ #
180
+ #
181
+ #
182
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
238
183
  # @return [Hash<String,String>]
239
184
  #
240
185
  # @!attribute [rw] treatments
@@ -272,34 +217,6 @@ module Aws::CloudWatchEvidently
272
217
  include Aws::Structure
273
218
  end
274
219
 
275
- # @note When making an API call, you may pass CreateFeatureRequest
276
- # data as a hash:
277
- #
278
- # {
279
- # default_variation: "VariationName",
280
- # description: "Description",
281
- # entity_overrides: {
282
- # "EntityId" => "VariationName",
283
- # },
284
- # evaluation_strategy: "ALL_RULES", # accepts ALL_RULES, DEFAULT_VARIATION
285
- # name: "FeatureName", # required
286
- # project: "ProjectRef", # required
287
- # tags: {
288
- # "TagKey" => "TagValue",
289
- # },
290
- # variations: [ # required
291
- # {
292
- # name: "VariationName", # required
293
- # value: { # required
294
- # bool_value: false,
295
- # double_value: 1.0,
296
- # long_value: 1,
297
- # string_value: "VariableValueStringValueString",
298
- # },
299
- # },
300
- # ],
301
- # }
302
- #
303
220
  # @!attribute [rw] default_variation
304
221
  # The name of the variation to use as the default variation. The
305
222
  # default variation is served to users who are not allocated to any
@@ -348,7 +265,14 @@ module Aws::CloudWatchEvidently
348
265
  # Tags don't have any semantic meaning to Amazon Web Services and are
349
266
  # interpreted strictly as strings of characters.
350
267
  #
351
- # <p>You can associate as many as 50 tags with a feature.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
268
+ # You can associate as many as 50 tags with a feature.
269
+ #
270
+ # For more information, see [Tagging Amazon Web Services
271
+ # resources][1].
272
+ #
273
+ #
274
+ #
275
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
352
276
  # @return [Hash<String,String>]
353
277
  #
354
278
  # @!attribute [rw] variations
@@ -383,57 +307,6 @@ module Aws::CloudWatchEvidently
383
307
  include Aws::Structure
384
308
  end
385
309
 
386
- # @note When making an API call, you may pass CreateLaunchRequest
387
- # data as a hash:
388
- #
389
- # {
390
- # description: "Description",
391
- # groups: [ # required
392
- # {
393
- # description: "Description",
394
- # feature: "FeatureName", # required
395
- # name: "GroupName", # required
396
- # variation: "VariationName", # required
397
- # },
398
- # ],
399
- # metric_monitors: [
400
- # {
401
- # metric_definition: { # required
402
- # entity_id_key: "JsonPath", # required
403
- # event_pattern: "MetricDefinitionConfigEventPatternString",
404
- # name: "CwDimensionSafeName", # required
405
- # unit_label: "MetricUnitLabel",
406
- # value_key: "JsonPath", # required
407
- # },
408
- # },
409
- # ],
410
- # name: "LaunchName", # required
411
- # project: "ProjectRef", # required
412
- # randomization_salt: "RandomizationSalt",
413
- # scheduled_splits_config: {
414
- # steps: [ # required
415
- # {
416
- # group_weights: { # required
417
- # "GroupName" => 1,
418
- # },
419
- # segment_overrides: [
420
- # {
421
- # evaluation_order: 1, # required
422
- # segment: "SegmentRef", # required
423
- # weights: { # required
424
- # "GroupName" => 1,
425
- # },
426
- # },
427
- # ],
428
- # start_time: Time.now, # required
429
- # },
430
- # ],
431
- # },
432
- # tags: {
433
- # "TagKey" => "TagValue",
434
- # },
435
- # }
436
- #
437
310
  # @!attribute [rw] description
438
311
  # An optional description for the launch.
439
312
  # @return [String]
@@ -482,7 +355,14 @@ module Aws::CloudWatchEvidently
482
355
  # Tags don't have any semantic meaning to Amazon Web Services and are
483
356
  # interpreted strictly as strings of characters.
484
357
  #
485
- # <p>You can associate as many as 50 tags with a launch.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
358
+ # You can associate as many as 50 tags with a launch.
359
+ #
360
+ # For more information, see [Tagging Amazon Web Services
361
+ # resources][1].
362
+ #
363
+ #
364
+ #
365
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
486
366
  # @return [Hash<String,String>]
487
367
  #
488
368
  # @see http://docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/CreateLaunchRequest AWS API Documentation
@@ -513,30 +393,6 @@ module Aws::CloudWatchEvidently
513
393
  include Aws::Structure
514
394
  end
515
395
 
516
- # @note When making an API call, you may pass CreateProjectRequest
517
- # data as a hash:
518
- #
519
- # {
520
- # app_config_resource: {
521
- # application_id: "AppConfigResourceId",
522
- # environment_id: "AppConfigResourceId",
523
- # },
524
- # data_delivery: {
525
- # cloud_watch_logs: {
526
- # log_group: "CwLogGroupSafeName",
527
- # },
528
- # s3_destination: {
529
- # bucket: "S3BucketSafeName",
530
- # prefix: "S3PrefixSafeName",
531
- # },
532
- # },
533
- # description: "Description",
534
- # name: "ProjectName", # required
535
- # tags: {
536
- # "TagKey" => "TagValue",
537
- # },
538
- # }
539
- #
540
396
  # @!attribute [rw] app_config_resource
541
397
  # Use this parameter if the project will use *client-side evaluation
542
398
  # powered by AppConfig*. Client-side evaluation allows your
@@ -586,7 +442,14 @@ module Aws::CloudWatchEvidently
586
442
  # Tags don't have any semantic meaning to Amazon Web Services and are
587
443
  # interpreted strictly as strings of characters.
588
444
  #
589
- # <p>You can associate as many as 50 tags with a project.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
445
+ # You can associate as many as 50 tags with a project.
446
+ #
447
+ # For more information, see [Tagging Amazon Web Services
448
+ # resources][1].
449
+ #
450
+ #
451
+ #
452
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
590
453
  # @return [Hash<String,String>]
591
454
  #
592
455
  # @see http://docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/CreateProjectRequest AWS API Documentation
@@ -613,18 +476,6 @@ module Aws::CloudWatchEvidently
613
476
  include Aws::Structure
614
477
  end
615
478
 
616
- # @note When making an API call, you may pass CreateSegmentRequest
617
- # data as a hash:
618
- #
619
- # {
620
- # description: "Description",
621
- # name: "SegmentName", # required
622
- # pattern: "SegmentPattern", # required
623
- # tags: {
624
- # "TagKey" => "TagValue",
625
- # },
626
- # }
627
- #
628
479
  # @!attribute [rw] description
629
480
  # An optional description for this segment.
630
481
  # @return [String]
@@ -653,7 +504,14 @@ module Aws::CloudWatchEvidently
653
504
  # Tags don't have any semantic meaning to Amazon Web Services and are
654
505
  # interpreted strictly as strings of characters.
655
506
  #
656
- # <p>You can associate as many as 50 tags with a segment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
507
+ # You can associate as many as 50 tags with a segment.
508
+ #
509
+ # For more information, see [Tagging Amazon Web Services
510
+ # resources][1].
511
+ #
512
+ #
513
+ #
514
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
657
515
  # @return [Hash<String,String>]
658
516
  #
659
517
  # @see http://docs.aws.amazon.com/goto/WebAPI/evidently-2021-02-01/CreateSegmentRequest AWS API Documentation
@@ -680,14 +538,6 @@ module Aws::CloudWatchEvidently
680
538
  include Aws::Structure
681
539
  end
682
540
 
683
- # @note When making an API call, you may pass DeleteExperimentRequest
684
- # data as a hash:
685
- #
686
- # {
687
- # experiment: "ExperimentName", # required
688
- # project: "ProjectRef", # required
689
- # }
690
- #
691
541
  # @!attribute [rw] experiment
692
542
  # The name of the experiment to delete.
693
543
  # @return [String]
@@ -710,14 +560,6 @@ module Aws::CloudWatchEvidently
710
560
  #
711
561
  class DeleteExperimentResponse < Aws::EmptyStructure; end
712
562
 
713
- # @note When making an API call, you may pass DeleteFeatureRequest
714
- # data as a hash:
715
- #
716
- # {
717
- # feature: "FeatureName", # required
718
- # project: "ProjectRef", # required
719
- # }
720
- #
721
563
  # @!attribute [rw] feature
722
564
  # The name of the feature to delete.
723
565
  # @return [String]
@@ -739,14 +581,6 @@ module Aws::CloudWatchEvidently
739
581
  #
740
582
  class DeleteFeatureResponse < Aws::EmptyStructure; end
741
583
 
742
- # @note When making an API call, you may pass DeleteLaunchRequest
743
- # data as a hash:
744
- #
745
- # {
746
- # launch: "LaunchName", # required
747
- # project: "ProjectRef", # required
748
- # }
749
- #
750
584
  # @!attribute [rw] launch
751
585
  # The name of the launch to delete.
752
586
  # @return [String]
@@ -768,13 +602,6 @@ module Aws::CloudWatchEvidently
768
602
  #
769
603
  class DeleteLaunchResponse < Aws::EmptyStructure; end
770
604
 
771
- # @note When making an API call, you may pass DeleteProjectRequest
772
- # data as a hash:
773
- #
774
- # {
775
- # project: "ProjectRef", # required
776
- # }
777
- #
778
605
  # @!attribute [rw] project
779
606
  # The name or ARN of the project to delete.
780
607
  # @return [String]
@@ -791,13 +618,6 @@ module Aws::CloudWatchEvidently
791
618
  #
792
619
  class DeleteProjectResponse < Aws::EmptyStructure; end
793
620
 
794
- # @note When making an API call, you may pass DeleteSegmentRequest
795
- # data as a hash:
796
- #
797
- # {
798
- # segment: "SegmentRef", # required
799
- # }
800
- #
801
621
  # @!attribute [rw] segment
802
622
  # Specifies the segment to delete.
803
623
  # @return [String]
@@ -814,16 +634,6 @@ module Aws::CloudWatchEvidently
814
634
  #
815
635
  class DeleteSegmentResponse < Aws::EmptyStructure; end
816
636
 
817
- # @note When making an API call, you may pass EvaluateFeatureRequest
818
- # data as a hash:
819
- #
820
- # {
821
- # entity_id: "EntityId", # required
822
- # evaluation_context: "JsonValue",
823
- # feature: "FeatureName", # required
824
- # project: "ProjectRef", # required
825
- # }
826
- #
827
637
  # @!attribute [rw] entity_id
828
638
  # An internal ID that represents a unique user of the application.
829
639
  # This `entityID` is checked against any override rules assigned for
@@ -837,7 +647,8 @@ module Aws::CloudWatchEvidently
837
647
  # audience segments. For more information, see [Use segments to focus
838
648
  # your audience][1].
839
649
  #
840
- # <p>If you include this parameter, the value must be a JSON object. A JSON array is not supported.</p>
650
+ # If you include this parameter, the value must be a JSON object. A
651
+ # JSON array is not supported.
841
652
  #
842
653
  #
843
654
  #
@@ -900,15 +711,6 @@ module Aws::CloudWatchEvidently
900
711
 
901
712
  # This structure assigns a feature variation to one user session.
902
713
  #
903
- # @note When making an API call, you may pass EvaluationRequest
904
- # data as a hash:
905
- #
906
- # {
907
- # entity_id: "EntityId", # required
908
- # evaluation_context: "JsonValue",
909
- # feature: "FeatureName", # required
910
- # }
911
- #
912
714
  # @!attribute [rw] entity_id
913
715
  # An internal ID that represents a unique user session of the
914
716
  # application. This `entityID` is checked against any override rules
@@ -1015,15 +817,6 @@ module Aws::CloudWatchEvidently
1015
817
  # event specifies a pre-defined event type, the payload must follow the
1016
818
  # defined event schema.
1017
819
  #
1018
- # @note When making an API call, you may pass Event
1019
- # data as a hash:
1020
- #
1021
- # {
1022
- # data: "JsonValue", # required
1023
- # timestamp: Time.now, # required
1024
- # type: "aws.evidently.evaluation", # required, accepts aws.evidently.evaluation, aws.evidently.custom
1025
- # }
1026
- #
1027
820
  # @!attribute [rw] data
1028
821
  # The event data.
1029
822
  # @return [String]
@@ -1438,14 +1231,6 @@ module Aws::CloudWatchEvidently
1438
1231
  include Aws::Structure
1439
1232
  end
1440
1233
 
1441
- # @note When making an API call, you may pass GetExperimentRequest
1442
- # data as a hash:
1443
- #
1444
- # {
1445
- # experiment: "ExperimentName", # required
1446
- # project: "ProjectRef", # required
1447
- # }
1448
- #
1449
1234
  # @!attribute [rw] experiment
1450
1235
  # The name of the experiment that you want to see the details of.
1451
1236
  # @return [String]
@@ -1475,22 +1260,6 @@ module Aws::CloudWatchEvidently
1475
1260
  include Aws::Structure
1476
1261
  end
1477
1262
 
1478
- # @note When making an API call, you may pass GetExperimentResultsRequest
1479
- # data as a hash:
1480
- #
1481
- # {
1482
- # base_stat: "Mean", # accepts Mean
1483
- # end_time: Time.now,
1484
- # experiment: "ExperimentName", # required
1485
- # metric_names: ["CwDimensionSafeName"], # required
1486
- # period: 1,
1487
- # project: "ProjectRef", # required
1488
- # report_names: ["BayesianInference"], # accepts BayesianInference
1489
- # result_stats: ["BaseStat"], # accepts BaseStat, TreatmentEffect, ConfidenceInterval, PValue
1490
- # start_time: Time.now,
1491
- # treatment_names: ["TreatmentName"], # required
1492
- # }
1493
- #
1494
1263
  # @!attribute [rw] base_stat
1495
1264
  # The statistic used to calculate experiment results. Currently the
1496
1265
  # only valid value is `mean`, which uses the mean of the collected
@@ -1609,14 +1378,6 @@ module Aws::CloudWatchEvidently
1609
1378
  include Aws::Structure
1610
1379
  end
1611
1380
 
1612
- # @note When making an API call, you may pass GetFeatureRequest
1613
- # data as a hash:
1614
- #
1615
- # {
1616
- # feature: "FeatureName", # required
1617
- # project: "ProjectRef", # required
1618
- # }
1619
- #
1620
1381
  # @!attribute [rw] feature
1621
1382
  # The name of the feature that you want to retrieve information for.
1622
1383
  # @return [String]
@@ -1646,14 +1407,6 @@ module Aws::CloudWatchEvidently
1646
1407
  include Aws::Structure
1647
1408
  end
1648
1409
 
1649
- # @note When making an API call, you may pass GetLaunchRequest
1650
- # data as a hash:
1651
- #
1652
- # {
1653
- # launch: "LaunchName", # required
1654
- # project: "ProjectRef", # required
1655
- # }
1656
- #
1657
1410
  # @!attribute [rw] launch
1658
1411
  # The name of the launch that you want to see the details of.
1659
1412
  # @return [String]
@@ -1683,13 +1436,6 @@ module Aws::CloudWatchEvidently
1683
1436
  include Aws::Structure
1684
1437
  end
1685
1438
 
1686
- # @note When making an API call, you may pass GetProjectRequest
1687
- # data as a hash:
1688
- #
1689
- # {
1690
- # project: "ProjectRef", # required
1691
- # }
1692
- #
1693
1439
  # @!attribute [rw] project
1694
1440
  # The name or ARN of the project that you want to see the details of.
1695
1441
  # @return [String]
@@ -1714,13 +1460,6 @@ module Aws::CloudWatchEvidently
1714
1460
  include Aws::Structure
1715
1461
  end
1716
1462
 
1717
- # @note When making an API call, you may pass GetSegmentRequest
1718
- # data as a hash:
1719
- #
1720
- # {
1721
- # segment: "SegmentRef", # required
1722
- # }
1723
- #
1724
1463
  # @!attribute [rw] segment
1725
1464
  # The ARN of the segment to return information for.
1726
1465
  # @return [String]
@@ -1902,16 +1641,6 @@ module Aws::CloudWatchEvidently
1902
1641
  # A structure that defines one launch group in a launch. A launch group
1903
1642
  # is a variation of the feature that you are including in the launch.
1904
1643
  #
1905
- # @note When making an API call, you may pass LaunchGroupConfig
1906
- # data as a hash:
1907
- #
1908
- # {
1909
- # description: "Description",
1910
- # feature: "FeatureName", # required
1911
- # name: "GroupName", # required
1912
- # variation: "VariationName", # required
1913
- # }
1914
- #
1915
1644
  # @!attribute [rw] description
1916
1645
  # A description of the launch group.
1917
1646
  # @return [String]
@@ -1939,16 +1668,6 @@ module Aws::CloudWatchEvidently
1939
1668
  include Aws::Structure
1940
1669
  end
1941
1670
 
1942
- # @note When making an API call, you may pass ListExperimentsRequest
1943
- # data as a hash:
1944
- #
1945
- # {
1946
- # max_results: 1,
1947
- # next_token: "NextToken",
1948
- # project: "ProjectRef", # required
1949
- # status: "CREATED", # accepts CREATED, UPDATING, RUNNING, COMPLETED, CANCELLED
1950
- # }
1951
- #
1952
1671
  # @!attribute [rw] max_results
1953
1672
  # The maximum number of results to include in the response.
1954
1673
  # @return [Integer]
@@ -1997,15 +1716,6 @@ module Aws::CloudWatchEvidently
1997
1716
  include Aws::Structure
1998
1717
  end
1999
1718
 
2000
- # @note When making an API call, you may pass ListFeaturesRequest
2001
- # data as a hash:
2002
- #
2003
- # {
2004
- # max_results: 1,
2005
- # next_token: "NextToken",
2006
- # project: "ProjectRef", # required
2007
- # }
2008
- #
2009
1719
  # @!attribute [rw] max_results
2010
1720
  # The maximum number of results to include in the response.
2011
1721
  # @return [Integer]
@@ -2048,16 +1758,6 @@ module Aws::CloudWatchEvidently
2048
1758
  include Aws::Structure
2049
1759
  end
2050
1760
 
2051
- # @note When making an API call, you may pass ListLaunchesRequest
2052
- # data as a hash:
2053
- #
2054
- # {
2055
- # max_results: 1,
2056
- # next_token: "NextToken",
2057
- # project: "ProjectRef", # required
2058
- # status: "CREATED", # accepts CREATED, UPDATING, RUNNING, COMPLETED, CANCELLED
2059
- # }
2060
- #
2061
1761
  # @!attribute [rw] max_results
2062
1762
  # The maximum number of results to include in the response.
2063
1763
  # @return [Integer]
@@ -2106,14 +1806,6 @@ module Aws::CloudWatchEvidently
2106
1806
  include Aws::Structure
2107
1807
  end
2108
1808
 
2109
- # @note When making an API call, you may pass ListProjectsRequest
2110
- # data as a hash:
2111
- #
2112
- # {
2113
- # max_results: 1,
2114
- # next_token: "NextToken",
2115
- # }
2116
- #
2117
1809
  # @!attribute [rw] max_results
2118
1810
  # The maximum number of results to include in the response.
2119
1811
  # @return [Integer]
@@ -2151,16 +1843,6 @@ module Aws::CloudWatchEvidently
2151
1843
  include Aws::Structure
2152
1844
  end
2153
1845
 
2154
- # @note When making an API call, you may pass ListSegmentReferencesRequest
2155
- # data as a hash:
2156
- #
2157
- # {
2158
- # max_results: 1,
2159
- # next_token: "NextToken",
2160
- # segment: "SegmentRef", # required
2161
- # type: "EXPERIMENT", # required, accepts EXPERIMENT, LAUNCH
2162
- # }
2163
- #
2164
1846
  # @!attribute [rw] max_results
2165
1847
  # The maximum number of results to include in the response. If you
2166
1848
  # omit this, the default of 50 is used.
@@ -2211,14 +1893,6 @@ module Aws::CloudWatchEvidently
2211
1893
  include Aws::Structure
2212
1894
  end
2213
1895
 
2214
- # @note When making an API call, you may pass ListSegmentsRequest
2215
- # data as a hash:
2216
- #
2217
- # {
2218
- # max_results: 1,
2219
- # next_token: "NextToken",
2220
- # }
2221
- #
2222
1896
  # @!attribute [rw] max_results
2223
1897
  # The maximum number of results to include in the response. If you
2224
1898
  # omit this, the default of 50 is used.
@@ -2257,13 +1931,6 @@ module Aws::CloudWatchEvidently
2257
1931
  include Aws::Structure
2258
1932
  end
2259
1933
 
2260
- # @note When making an API call, you may pass ListTagsForResourceRequest
2261
- # data as a hash:
2262
- #
2263
- # {
2264
- # resource_arn: "Arn", # required
2265
- # }
2266
- #
2267
1934
  # @!attribute [rw] resource_arn
2268
1935
  # The ARN of the resource that you want to see the tags of.
2269
1936
  # @return [String]
@@ -2336,17 +2003,6 @@ module Aws::CloudWatchEvidently
2336
2003
  # This structure defines a metric that you want to use to evaluate the
2337
2004
  # variations during a launch or experiment.
2338
2005
  #
2339
- # @note When making an API call, you may pass MetricDefinitionConfig
2340
- # data as a hash:
2341
- #
2342
- # {
2343
- # entity_id_key: "JsonPath", # required
2344
- # event_pattern: "MetricDefinitionConfigEventPatternString",
2345
- # name: "CwDimensionSafeName", # required
2346
- # unit_label: "MetricUnitLabel",
2347
- # value_key: "JsonPath", # required
2348
- # }
2349
- #
2350
2006
  # @!attribute [rw] entity_id_key
2351
2007
  # The entity, such as a user or session, that does an action that
2352
2008
  # causes a metric value to be recorded. An example is
@@ -2416,20 +2072,6 @@ module Aws::CloudWatchEvidently
2416
2072
  # Use this structure to tell Evidently whether higher or lower values
2417
2073
  # are desired for a metric that is used in an experiment.
2418
2074
  #
2419
- # @note When making an API call, you may pass MetricGoalConfig
2420
- # data as a hash:
2421
- #
2422
- # {
2423
- # desired_change: "INCREASE", # accepts INCREASE, DECREASE
2424
- # metric_definition: { # required
2425
- # entity_id_key: "JsonPath", # required
2426
- # event_pattern: "MetricDefinitionConfigEventPatternString",
2427
- # name: "CwDimensionSafeName", # required
2428
- # unit_label: "MetricUnitLabel",
2429
- # value_key: "JsonPath", # required
2430
- # },
2431
- # }
2432
- #
2433
2075
  # @!attribute [rw] desired_change
2434
2076
  # `INCREASE` means that a variation with a higher number for this
2435
2077
  # metric is performing better.
@@ -2469,19 +2111,6 @@ module Aws::CloudWatchEvidently
2469
2111
  # A structure that defines a metric to be used to monitor performance of
2470
2112
  # the variations during a launch.
2471
2113
  #
2472
- # @note When making an API call, you may pass MetricMonitorConfig
2473
- # data as a hash:
2474
- #
2475
- # {
2476
- # metric_definition: { # required
2477
- # entity_id_key: "JsonPath", # required
2478
- # event_pattern: "MetricDefinitionConfigEventPatternString",
2479
- # name: "CwDimensionSafeName", # required
2480
- # unit_label: "MetricUnitLabel",
2481
- # value_key: "JsonPath", # required
2482
- # },
2483
- # }
2484
- #
2485
2114
  # @!attribute [rw] metric_definition
2486
2115
  # A structure that defines the metric.
2487
2116
  # @return [Types::MetricDefinitionConfig]
@@ -2499,16 +2128,6 @@ module Aws::CloudWatchEvidently
2499
2128
  # comparison with other variations. This structure also specifies how
2500
2129
  # much experiment traffic is allocated to each variation.
2501
2130
  #
2502
- # @note When making an API call, you may pass OnlineAbConfig
2503
- # data as a hash:
2504
- #
2505
- # {
2506
- # control_treatment_name: "TreatmentName",
2507
- # treatment_weights: {
2508
- # "TreatmentName" => 1,
2509
- # },
2510
- # }
2511
- #
2512
2131
  # @!attribute [rw] control_treatment_name
2513
2132
  # The name of the variation that is to be the default variation that
2514
2133
  # the other variations are compared to.
@@ -2688,14 +2307,6 @@ module Aws::CloudWatchEvidently
2688
2307
  #
2689
2308
  # [1]: https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_EvaluateFeature.html
2690
2309
  #
2691
- # @note When making an API call, you may pass ProjectAppConfigResourceConfig
2692
- # data as a hash:
2693
- #
2694
- # {
2695
- # application_id: "AppConfigResourceId",
2696
- # environment_id: "AppConfigResourceId",
2697
- # }
2698
- #
2699
2310
  # @!attribute [rw] application_id
2700
2311
  # The ID of the AppConfig application to use for client-side
2701
2312
  # evaluation.
@@ -2741,19 +2352,6 @@ module Aws::CloudWatchEvidently
2741
2352
  # A structure that contains information about where Evidently is to
2742
2353
  # store evaluation events for longer term storage.
2743
2354
  #
2744
- # @note When making an API call, you may pass ProjectDataDeliveryConfig
2745
- # data as a hash:
2746
- #
2747
- # {
2748
- # cloud_watch_logs: {
2749
- # log_group: "CwLogGroupSafeName",
2750
- # },
2751
- # s3_destination: {
2752
- # bucket: "S3BucketSafeName",
2753
- # prefix: "S3PrefixSafeName",
2754
- # },
2755
- # }
2756
- #
2757
2355
  # @!attribute [rw] cloud_watch_logs
2758
2356
  # If the project stores evaluation events in CloudWatch Logs, this
2759
2357
  # structure stores the log group name.
@@ -2844,20 +2442,6 @@ module Aws::CloudWatchEvidently
2844
2442
  include Aws::Structure
2845
2443
  end
2846
2444
 
2847
- # @note When making an API call, you may pass PutProjectEventsRequest
2848
- # data as a hash:
2849
- #
2850
- # {
2851
- # events: [ # required
2852
- # {
2853
- # data: "JsonValue", # required
2854
- # timestamp: Time.now, # required
2855
- # type: "aws.evidently.evaluation", # required, accepts aws.evidently.evaluation, aws.evidently.custom
2856
- # },
2857
- # ],
2858
- # project: "ProjectRef", # required
2859
- # }
2860
- #
2861
2445
  # @!attribute [rw] events
2862
2446
  # An array of event structures that contain the performance data that
2863
2447
  # is being sent to Evidently.
@@ -3015,14 +2599,6 @@ module Aws::CloudWatchEvidently
3015
2599
  # If the project stores evaluation events in an Amazon S3 bucket, this
3016
2600
  # structure stores the bucket name and bucket prefix.
3017
2601
  #
3018
- # @note When making an API call, you may pass S3DestinationConfig
3019
- # data as a hash:
3020
- #
3021
- # {
3022
- # bucket: "S3BucketSafeName",
3023
- # prefix: "S3PrefixSafeName",
3024
- # }
3025
- #
3026
2602
  # @!attribute [rw] bucket
3027
2603
  # The name of the bucket in which Evidently stores evaluation events.
3028
2604
  # @return [String]
@@ -3091,32 +2667,20 @@ module Aws::CloudWatchEvidently
3091
2667
  # feature variations during one step of a launch, and the start time of
3092
2668
  # that step.
3093
2669
  #
3094
- # @note When making an API call, you may pass ScheduledSplitConfig
3095
- # data as a hash:
3096
- #
3097
- # {
3098
- # group_weights: { # required
3099
- # "GroupName" => 1,
3100
- # },
3101
- # segment_overrides: [
3102
- # {
3103
- # evaluation_order: 1, # required
3104
- # segment: "SegmentRef", # required
3105
- # weights: { # required
3106
- # "GroupName" => 1,
3107
- # },
3108
- # },
3109
- # ],
3110
- # start_time: Time.now, # required
3111
- # }
3112
- #
3113
2670
  # @!attribute [rw] group_weights
3114
2671
  # The traffic allocation percentages among the feature variations
3115
2672
  # during one step of a launch. This is a set of key-value pairs. The
3116
2673
  # keys are variation names. The values represent the percentage of
3117
2674
  # traffic to allocate to that variation during this step.
3118
2675
  #
3119
- # <p>The values is expressed in thousandths of a percent, so assigning a weight of 50000 assigns 50% of traffic to that variation.</p> <p>If the sum of the weights for all the variations in a segment override does not add up to 100,000, then the remaining traffic that matches this segment is not assigned by this segment override, and instead moves on to the next segment override or the default traffic split.</p>
2676
+ # The values is expressed in thousandths of a percent, so assigning a
2677
+ # weight of 50000 assigns 50% of traffic to that variation.
2678
+ #
2679
+ # If the sum of the weights for all the variations in a segment
2680
+ # override does not add up to 100,000, then the remaining traffic that
2681
+ # matches this segment is not assigned by this segment override, and
2682
+ # instead moves on to the next segment override or the default traffic
2683
+ # split.
3120
2684
  # @return [Hash<String,Integer>]
3121
2685
  #
3122
2686
  # @!attribute [rw] segment_overrides
@@ -3150,29 +2714,6 @@ module Aws::CloudWatchEvidently
3150
2714
  # among the feature variations during each step of a launch. This also
3151
2715
  # defines the start time of each step.
3152
2716
  #
3153
- # @note When making an API call, you may pass ScheduledSplitsLaunchConfig
3154
- # data as a hash:
3155
- #
3156
- # {
3157
- # steps: [ # required
3158
- # {
3159
- # group_weights: { # required
3160
- # "GroupName" => 1,
3161
- # },
3162
- # segment_overrides: [
3163
- # {
3164
- # evaluation_order: 1, # required
3165
- # segment: "SegmentRef", # required
3166
- # weights: { # required
3167
- # "GroupName" => 1,
3168
- # },
3169
- # },
3170
- # ],
3171
- # start_time: Time.now, # required
3172
- # },
3173
- # ],
3174
- # }
3175
- #
3176
2717
  # @!attribute [rw] steps
3177
2718
  # An array of structures that define the traffic allocation
3178
2719
  # percentages among the feature variations during each step of the
@@ -3275,17 +2816,6 @@ module Aws::CloudWatchEvidently
3275
2816
  # This structure specifies a segment that you have already created, and
3276
2817
  # defines the traffic split for that segment to be used in a launch.
3277
2818
  #
3278
- # @note When making an API call, you may pass SegmentOverride
3279
- # data as a hash:
3280
- #
3281
- # {
3282
- # evaluation_order: 1, # required
3283
- # segment: "SegmentRef", # required
3284
- # weights: { # required
3285
- # "GroupName" => 1,
3286
- # },
3287
- # }
3288
- #
3289
2819
  # @!attribute [rw] evaluation_order
3290
2820
  # A number indicating the order to use to evaluate segment overrides,
3291
2821
  # if there are more than one. Segment overrides with lower numbers are
@@ -3361,15 +2891,6 @@ module Aws::CloudWatchEvidently
3361
2891
  include Aws::Structure
3362
2892
  end
3363
2893
 
3364
- # @note When making an API call, you may pass StartExperimentRequest
3365
- # data as a hash:
3366
- #
3367
- # {
3368
- # analysis_complete_time: Time.now, # required
3369
- # experiment: "ExperimentName", # required
3370
- # project: "ProjectRef", # required
3371
- # }
3372
- #
3373
2894
  # @!attribute [rw] analysis_complete_time
3374
2895
  # The date and time to end the experiment. This must be no more than
3375
2896
  # 30 days after the experiment starts.
@@ -3406,14 +2927,6 @@ module Aws::CloudWatchEvidently
3406
2927
  include Aws::Structure
3407
2928
  end
3408
2929
 
3409
- # @note When making an API call, you may pass StartLaunchRequest
3410
- # data as a hash:
3411
- #
3412
- # {
3413
- # launch: "LaunchName", # required
3414
- # project: "ProjectRef", # required
3415
- # }
3416
- #
3417
2930
  # @!attribute [rw] launch
3418
2931
  # The name of the launch to start.
3419
2932
  # @return [String]
@@ -3444,16 +2957,6 @@ module Aws::CloudWatchEvidently
3444
2957
  include Aws::Structure
3445
2958
  end
3446
2959
 
3447
- # @note When making an API call, you may pass StopExperimentRequest
3448
- # data as a hash:
3449
- #
3450
- # {
3451
- # desired_state: "COMPLETED", # accepts COMPLETED, CANCELLED
3452
- # experiment: "ExperimentName", # required
3453
- # project: "ProjectRef", # required
3454
- # reason: "Description",
3455
- # }
3456
- #
3457
2960
  # @!attribute [rw] desired_state
3458
2961
  # Specify whether the experiment is to be considered `COMPLETED` or
3459
2962
  # `CANCELLED` after it stops.
@@ -3494,16 +2997,6 @@ module Aws::CloudWatchEvidently
3494
2997
  include Aws::Structure
3495
2998
  end
3496
2999
 
3497
- # @note When making an API call, you may pass StopLaunchRequest
3498
- # data as a hash:
3499
- #
3500
- # {
3501
- # desired_state: "COMPLETED", # accepts COMPLETED, CANCELLED
3502
- # launch: "LaunchName", # required
3503
- # project: "ProjectRef", # required
3504
- # reason: "Description",
3505
- # }
3506
- #
3507
3000
  # @!attribute [rw] desired_state
3508
3001
  # Specify whether to consider the launch as `COMPLETED` or `CANCELLED`
3509
3002
  # after it stops.
@@ -3545,16 +3038,6 @@ module Aws::CloudWatchEvidently
3545
3038
  include Aws::Structure
3546
3039
  end
3547
3040
 
3548
- # @note When making an API call, you may pass TagResourceRequest
3549
- # data as a hash:
3550
- #
3551
- # {
3552
- # resource_arn: "Arn", # required
3553
- # tags: { # required
3554
- # "TagKey" => "TagValue",
3555
- # },
3556
- # }
3557
- #
3558
3041
  # @!attribute [rw] resource_arn
3559
3042
  # The ARN of the CloudWatch Evidently resource that you're adding
3560
3043
  # tags to.
@@ -3577,14 +3060,6 @@ module Aws::CloudWatchEvidently
3577
3060
  #
3578
3061
  class TagResourceResponse < Aws::EmptyStructure; end
3579
3062
 
3580
- # @note When making an API call, you may pass TestSegmentPatternRequest
3581
- # data as a hash:
3582
- #
3583
- # {
3584
- # pattern: "SegmentPattern", # required
3585
- # payload: "JsonValue", # required
3586
- # }
3587
- #
3588
3063
  # @!attribute [rw] pattern
3589
3064
  # The pattern to test.
3590
3065
  # @return [String]
@@ -3671,16 +3146,6 @@ module Aws::CloudWatchEvidently
3671
3146
  # is a variation of the feature that you are including in the
3672
3147
  # experiment.
3673
3148
  #
3674
- # @note When making an API call, you may pass TreatmentConfig
3675
- # data as a hash:
3676
- #
3677
- # {
3678
- # description: "Description",
3679
- # feature: "FeatureName", # required
3680
- # name: "TreatmentName", # required
3681
- # variation: "VariationName", # required
3682
- # }
3683
- #
3684
3149
  # @!attribute [rw] description
3685
3150
  # A description for this treatment.
3686
3151
  # @return [String]
@@ -3709,14 +3174,6 @@ module Aws::CloudWatchEvidently
3709
3174
  include Aws::Structure
3710
3175
  end
3711
3176
 
3712
- # @note When making an API call, you may pass UntagResourceRequest
3713
- # data as a hash:
3714
- #
3715
- # {
3716
- # resource_arn: "Arn", # required
3717
- # tag_keys: ["TagKey"], # required
3718
- # }
3719
- #
3720
3177
  # @!attribute [rw] resource_arn
3721
3178
  # The ARN of the CloudWatch Evidently resource that you're removing
3722
3179
  # tags from.
@@ -3739,45 +3196,6 @@ module Aws::CloudWatchEvidently
3739
3196
  #
3740
3197
  class UntagResourceResponse < Aws::EmptyStructure; end
3741
3198
 
3742
- # @note When making an API call, you may pass UpdateExperimentRequest
3743
- # data as a hash:
3744
- #
3745
- # {
3746
- # description: "Description",
3747
- # experiment: "ExperimentName", # required
3748
- # metric_goals: [
3749
- # {
3750
- # desired_change: "INCREASE", # accepts INCREASE, DECREASE
3751
- # metric_definition: { # required
3752
- # entity_id_key: "JsonPath", # required
3753
- # event_pattern: "MetricDefinitionConfigEventPatternString",
3754
- # name: "CwDimensionSafeName", # required
3755
- # unit_label: "MetricUnitLabel",
3756
- # value_key: "JsonPath", # required
3757
- # },
3758
- # },
3759
- # ],
3760
- # online_ab_config: {
3761
- # control_treatment_name: "TreatmentName",
3762
- # treatment_weights: {
3763
- # "TreatmentName" => 1,
3764
- # },
3765
- # },
3766
- # project: "ProjectRef", # required
3767
- # randomization_salt: "RandomizationSalt",
3768
- # remove_segment: false,
3769
- # sampling_rate: 1,
3770
- # segment: "SegmentRef",
3771
- # treatments: [
3772
- # {
3773
- # description: "Description",
3774
- # feature: "FeatureName", # required
3775
- # name: "TreatmentName", # required
3776
- # variation: "VariationName", # required
3777
- # },
3778
- # ],
3779
- # }
3780
- #
3781
3199
  # @!attribute [rw] description
3782
3200
  # An optional description of the experiment.
3783
3201
  # @return [String]
@@ -3869,32 +3287,6 @@ module Aws::CloudWatchEvidently
3869
3287
  include Aws::Structure
3870
3288
  end
3871
3289
 
3872
- # @note When making an API call, you may pass UpdateFeatureRequest
3873
- # data as a hash:
3874
- #
3875
- # {
3876
- # add_or_update_variations: [
3877
- # {
3878
- # name: "VariationName", # required
3879
- # value: { # required
3880
- # bool_value: false,
3881
- # double_value: 1.0,
3882
- # long_value: 1,
3883
- # string_value: "VariableValueStringValueString",
3884
- # },
3885
- # },
3886
- # ],
3887
- # default_variation: "VariationName",
3888
- # description: "Description",
3889
- # entity_overrides: {
3890
- # "EntityId" => "VariationName",
3891
- # },
3892
- # evaluation_strategy: "ALL_RULES", # accepts ALL_RULES, DEFAULT_VARIATION
3893
- # feature: "FeatureName", # required
3894
- # project: "ProjectRef", # required
3895
- # remove_variations: ["VariationName"],
3896
- # }
3897
- #
3898
3290
  # @!attribute [rw] add_or_update_variations
3899
3291
  # To update variation configurations for this feature, or add new
3900
3292
  # ones, specify this structure. In this array, include any variations
@@ -3972,54 +3364,6 @@ module Aws::CloudWatchEvidently
3972
3364
  include Aws::Structure
3973
3365
  end
3974
3366
 
3975
- # @note When making an API call, you may pass UpdateLaunchRequest
3976
- # data as a hash:
3977
- #
3978
- # {
3979
- # description: "Description",
3980
- # groups: [
3981
- # {
3982
- # description: "Description",
3983
- # feature: "FeatureName", # required
3984
- # name: "GroupName", # required
3985
- # variation: "VariationName", # required
3986
- # },
3987
- # ],
3988
- # launch: "LaunchName", # required
3989
- # metric_monitors: [
3990
- # {
3991
- # metric_definition: { # required
3992
- # entity_id_key: "JsonPath", # required
3993
- # event_pattern: "MetricDefinitionConfigEventPatternString",
3994
- # name: "CwDimensionSafeName", # required
3995
- # unit_label: "MetricUnitLabel",
3996
- # value_key: "JsonPath", # required
3997
- # },
3998
- # },
3999
- # ],
4000
- # project: "ProjectRef", # required
4001
- # randomization_salt: "RandomizationSalt",
4002
- # scheduled_splits_config: {
4003
- # steps: [ # required
4004
- # {
4005
- # group_weights: { # required
4006
- # "GroupName" => 1,
4007
- # },
4008
- # segment_overrides: [
4009
- # {
4010
- # evaluation_order: 1, # required
4011
- # segment: "SegmentRef", # required
4012
- # weights: { # required
4013
- # "GroupName" => 1,
4014
- # },
4015
- # },
4016
- # ],
4017
- # start_time: Time.now, # required
4018
- # },
4019
- # ],
4020
- # },
4021
- # }
4022
- #
4023
3367
  # @!attribute [rw] description
4024
3368
  # An optional description for the launch.
4025
3369
  # @return [String]
@@ -4084,20 +3428,6 @@ module Aws::CloudWatchEvidently
4084
3428
  include Aws::Structure
4085
3429
  end
4086
3430
 
4087
- # @note When making an API call, you may pass UpdateProjectDataDeliveryRequest
4088
- # data as a hash:
4089
- #
4090
- # {
4091
- # cloud_watch_logs: {
4092
- # log_group: "CwLogGroupSafeName",
4093
- # },
4094
- # project: "ProjectRef", # required
4095
- # s3_destination: {
4096
- # bucket: "S3BucketSafeName",
4097
- # prefix: "S3PrefixSafeName",
4098
- # },
4099
- # }
4100
- #
4101
3431
  # @!attribute [rw] cloud_watch_logs
4102
3432
  # A structure containing the CloudWatch Logs log group where you want
4103
3433
  # to store evaluation events.
@@ -4135,18 +3465,6 @@ module Aws::CloudWatchEvidently
4135
3465
  include Aws::Structure
4136
3466
  end
4137
3467
 
4138
- # @note When making an API call, you may pass UpdateProjectRequest
4139
- # data as a hash:
4140
- #
4141
- # {
4142
- # app_config_resource: {
4143
- # application_id: "AppConfigResourceId",
4144
- # environment_id: "AppConfigResourceId",
4145
- # },
4146
- # description: "Description",
4147
- # project: "ProjectRef", # required
4148
- # }
4149
- #
4150
3468
  # @!attribute [rw] app_config_resource
4151
3469
  # Use this parameter if the project will use client-side evaluation
4152
3470
  # powered by AppConfig. Client-side evaluation allows your application
@@ -4304,19 +3622,6 @@ module Aws::CloudWatchEvidently
4304
3622
  # This structure contains the name and variation value of one variation
4305
3623
  # of a feature.
4306
3624
  #
4307
- # @note When making an API call, you may pass VariationConfig
4308
- # data as a hash:
4309
- #
4310
- # {
4311
- # name: "VariationName", # required
4312
- # value: { # required
4313
- # bool_value: false,
4314
- # double_value: 1.0,
4315
- # long_value: 1,
4316
- # string_value: "VariableValueStringValueString",
4317
- # },
4318
- # }
4319
- #
4320
3625
  # @!attribute [rw] name
4321
3626
  # The name of the variation.
4322
3627
  # @return [String]