1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct GetExperimentResultsInput {
/// <p>The name or ARN of the project that contains the experiment that you want to see the results of.</p>
pub project: ::std::option::Option<::std::string::String>,
/// <p>The name of the experiment to retrieve the results of.</p>
pub experiment: ::std::option::Option<::std::string::String>,
/// <p>The date and time that the experiment started.</p>
pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>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.</p>
pub end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The names of the experiment metrics that you want to see the results of.</p>
pub metric_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The names of the experiment treatments that you want to see the results for.</p>
pub treatment_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The statistic used to calculate experiment results. Currently the only valid value is <code>mean</code>, which uses the mean of the collected values as the statistic.</p>
pub base_stat: ::std::option::Option<crate::types::ExperimentBaseStat>,
/// <p>The statistics that you want to see in the returned results.</p>
/// <ul>
/// <li>
/// <p><code>PValue</code> specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.</p></li>
/// <li>
/// <p><code>ConfidenceInterval</code> specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the <code>baseStat</code> of a variation and the baseline. Evidently returns the 95% confidence interval.</p></li>
/// <li>
/// <p><code>TreatmentEffect</code> is the difference in the statistic specified by the <code>baseStat</code> parameter between each variation and the default variation.</p></li>
/// <li>
/// <p><code>BaseStat</code> returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the <code>baseStat</code> parameter. Therefore, if <code>baseStat</code> is <code>mean</code>, this returns the mean of the values collected for each variation.</p></li>
/// </ul>
pub result_stats: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentResultRequestType>>,
/// <p>The names of the report types that you want to see. Currently, <code>BayesianInference</code> is the only valid value.</p>
pub report_names: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentReportName>>,
/// <p>In seconds, the amount of time to aggregate results together.</p>
pub period: ::std::option::Option<i64>,
}
impl GetExperimentResultsInput {
/// <p>The name or ARN of the project that contains the experiment that you want to see the results of.</p>
pub fn project(&self) -> ::std::option::Option<&str> {
self.project.as_deref()
}
/// <p>The name of the experiment to retrieve the results of.</p>
pub fn experiment(&self) -> ::std::option::Option<&str> {
self.experiment.as_deref()
}
/// <p>The date and time that the experiment started.</p>
pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.start_time.as_ref()
}
/// <p>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.</p>
pub fn end_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.end_time.as_ref()
}
/// <p>The names of the experiment metrics that you want to see the results of.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.metric_names.is_none()`.
pub fn metric_names(&self) -> &[::std::string::String] {
self.metric_names.as_deref().unwrap_or_default()
}
/// <p>The names of the experiment treatments that you want to see the results for.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.treatment_names.is_none()`.
pub fn treatment_names(&self) -> &[::std::string::String] {
self.treatment_names.as_deref().unwrap_or_default()
}
/// <p>The statistic used to calculate experiment results. Currently the only valid value is <code>mean</code>, which uses the mean of the collected values as the statistic.</p>
pub fn base_stat(&self) -> ::std::option::Option<&crate::types::ExperimentBaseStat> {
self.base_stat.as_ref()
}
/// <p>The statistics that you want to see in the returned results.</p>
/// <ul>
/// <li>
/// <p><code>PValue</code> specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.</p></li>
/// <li>
/// <p><code>ConfidenceInterval</code> specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the <code>baseStat</code> of a variation and the baseline. Evidently returns the 95% confidence interval.</p></li>
/// <li>
/// <p><code>TreatmentEffect</code> is the difference in the statistic specified by the <code>baseStat</code> parameter between each variation and the default variation.</p></li>
/// <li>
/// <p><code>BaseStat</code> returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the <code>baseStat</code> parameter. Therefore, if <code>baseStat</code> is <code>mean</code>, this returns the mean of the values collected for each variation.</p></li>
/// </ul>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.result_stats.is_none()`.
pub fn result_stats(&self) -> &[crate::types::ExperimentResultRequestType] {
self.result_stats.as_deref().unwrap_or_default()
}
/// <p>The names of the report types that you want to see. Currently, <code>BayesianInference</code> is the only valid value.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.report_names.is_none()`.
pub fn report_names(&self) -> &[crate::types::ExperimentReportName] {
self.report_names.as_deref().unwrap_or_default()
}
/// <p>In seconds, the amount of time to aggregate results together.</p>
pub fn period(&self) -> ::std::option::Option<i64> {
self.period
}
}
impl GetExperimentResultsInput {
/// Creates a new builder-style object to manufacture [`GetExperimentResultsInput`](crate::operation::get_experiment_results::GetExperimentResultsInput).
pub fn builder() -> crate::operation::get_experiment_results::builders::GetExperimentResultsInputBuilder {
crate::operation::get_experiment_results::builders::GetExperimentResultsInputBuilder::default()
}
}
/// A builder for [`GetExperimentResultsInput`](crate::operation::get_experiment_results::GetExperimentResultsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct GetExperimentResultsInputBuilder {
pub(crate) project: ::std::option::Option<::std::string::String>,
pub(crate) experiment: ::std::option::Option<::std::string::String>,
pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) metric_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) treatment_names: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) base_stat: ::std::option::Option<crate::types::ExperimentBaseStat>,
pub(crate) result_stats: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentResultRequestType>>,
pub(crate) report_names: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentReportName>>,
pub(crate) period: ::std::option::Option<i64>,
}
impl GetExperimentResultsInputBuilder {
/// <p>The name or ARN of the project that contains the experiment that you want to see the results of.</p>
/// This field is required.
pub fn project(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.project = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or ARN of the project that contains the experiment that you want to see the results of.</p>
pub fn set_project(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.project = input;
self
}
/// <p>The name or ARN of the project that contains the experiment that you want to see the results of.</p>
pub fn get_project(&self) -> &::std::option::Option<::std::string::String> {
&self.project
}
/// <p>The name of the experiment to retrieve the results of.</p>
/// This field is required.
pub fn experiment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.experiment = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the experiment to retrieve the results of.</p>
pub fn set_experiment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.experiment = input;
self
}
/// <p>The name of the experiment to retrieve the results of.</p>
pub fn get_experiment(&self) -> &::std::option::Option<::std::string::String> {
&self.experiment
}
/// <p>The date and time that the experiment started.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.start_time = ::std::option::Option::Some(input);
self
}
/// <p>The date and time that the experiment started.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.start_time = input;
self
}
/// <p>The date and time that the experiment started.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.start_time
}
/// <p>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.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.end_time = ::std::option::Option::Some(input);
self
}
/// <p>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.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.end_time = input;
self
}
/// <p>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.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.end_time
}
/// Appends an item to `metric_names`.
///
/// To override the contents of this collection use [`set_metric_names`](Self::set_metric_names).
///
/// <p>The names of the experiment metrics that you want to see the results of.</p>
pub fn metric_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.metric_names.unwrap_or_default();
v.push(input.into());
self.metric_names = ::std::option::Option::Some(v);
self
}
/// <p>The names of the experiment metrics that you want to see the results of.</p>
pub fn set_metric_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.metric_names = input;
self
}
/// <p>The names of the experiment metrics that you want to see the results of.</p>
pub fn get_metric_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.metric_names
}
/// Appends an item to `treatment_names`.
///
/// To override the contents of this collection use [`set_treatment_names`](Self::set_treatment_names).
///
/// <p>The names of the experiment treatments that you want to see the results for.</p>
pub fn treatment_names(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.treatment_names.unwrap_or_default();
v.push(input.into());
self.treatment_names = ::std::option::Option::Some(v);
self
}
/// <p>The names of the experiment treatments that you want to see the results for.</p>
pub fn set_treatment_names(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.treatment_names = input;
self
}
/// <p>The names of the experiment treatments that you want to see the results for.</p>
pub fn get_treatment_names(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.treatment_names
}
/// <p>The statistic used to calculate experiment results. Currently the only valid value is <code>mean</code>, which uses the mean of the collected values as the statistic.</p>
pub fn base_stat(mut self, input: crate::types::ExperimentBaseStat) -> Self {
self.base_stat = ::std::option::Option::Some(input);
self
}
/// <p>The statistic used to calculate experiment results. Currently the only valid value is <code>mean</code>, which uses the mean of the collected values as the statistic.</p>
pub fn set_base_stat(mut self, input: ::std::option::Option<crate::types::ExperimentBaseStat>) -> Self {
self.base_stat = input;
self
}
/// <p>The statistic used to calculate experiment results. Currently the only valid value is <code>mean</code>, which uses the mean of the collected values as the statistic.</p>
pub fn get_base_stat(&self) -> &::std::option::Option<crate::types::ExperimentBaseStat> {
&self.base_stat
}
/// Appends an item to `result_stats`.
///
/// To override the contents of this collection use [`set_result_stats`](Self::set_result_stats).
///
/// <p>The statistics that you want to see in the returned results.</p>
/// <ul>
/// <li>
/// <p><code>PValue</code> specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.</p></li>
/// <li>
/// <p><code>ConfidenceInterval</code> specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the <code>baseStat</code> of a variation and the baseline. Evidently returns the 95% confidence interval.</p></li>
/// <li>
/// <p><code>TreatmentEffect</code> is the difference in the statistic specified by the <code>baseStat</code> parameter between each variation and the default variation.</p></li>
/// <li>
/// <p><code>BaseStat</code> returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the <code>baseStat</code> parameter. Therefore, if <code>baseStat</code> is <code>mean</code>, this returns the mean of the values collected for each variation.</p></li>
/// </ul>
pub fn result_stats(mut self, input: crate::types::ExperimentResultRequestType) -> Self {
let mut v = self.result_stats.unwrap_or_default();
v.push(input);
self.result_stats = ::std::option::Option::Some(v);
self
}
/// <p>The statistics that you want to see in the returned results.</p>
/// <ul>
/// <li>
/// <p><code>PValue</code> specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.</p></li>
/// <li>
/// <p><code>ConfidenceInterval</code> specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the <code>baseStat</code> of a variation and the baseline. Evidently returns the 95% confidence interval.</p></li>
/// <li>
/// <p><code>TreatmentEffect</code> is the difference in the statistic specified by the <code>baseStat</code> parameter between each variation and the default variation.</p></li>
/// <li>
/// <p><code>BaseStat</code> returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the <code>baseStat</code> parameter. Therefore, if <code>baseStat</code> is <code>mean</code>, this returns the mean of the values collected for each variation.</p></li>
/// </ul>
pub fn set_result_stats(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentResultRequestType>>) -> Self {
self.result_stats = input;
self
}
/// <p>The statistics that you want to see in the returned results.</p>
/// <ul>
/// <li>
/// <p><code>PValue</code> specifies to use p-values for the results. A p-value is used in hypothesis testing to measure how often you are willing to make a mistake in rejecting the null hypothesis. A general practice is to reject the null hypothesis and declare that the results are statistically significant when the p-value is less than 0.05.</p></li>
/// <li>
/// <p><code>ConfidenceInterval</code> specifies a confidence interval for the results. The confidence interval represents the range of values for the chosen metric that is likely to contain the true difference between the <code>baseStat</code> of a variation and the baseline. Evidently returns the 95% confidence interval.</p></li>
/// <li>
/// <p><code>TreatmentEffect</code> is the difference in the statistic specified by the <code>baseStat</code> parameter between each variation and the default variation.</p></li>
/// <li>
/// <p><code>BaseStat</code> returns the statistical values collected for the metric for each variation. The statistic uses the same statistic specified in the <code>baseStat</code> parameter. Therefore, if <code>baseStat</code> is <code>mean</code>, this returns the mean of the values collected for each variation.</p></li>
/// </ul>
pub fn get_result_stats(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ExperimentResultRequestType>> {
&self.result_stats
}
/// Appends an item to `report_names`.
///
/// To override the contents of this collection use [`set_report_names`](Self::set_report_names).
///
/// <p>The names of the report types that you want to see. Currently, <code>BayesianInference</code> is the only valid value.</p>
pub fn report_names(mut self, input: crate::types::ExperimentReportName) -> Self {
let mut v = self.report_names.unwrap_or_default();
v.push(input);
self.report_names = ::std::option::Option::Some(v);
self
}
/// <p>The names of the report types that you want to see. Currently, <code>BayesianInference</code> is the only valid value.</p>
pub fn set_report_names(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ExperimentReportName>>) -> Self {
self.report_names = input;
self
}
/// <p>The names of the report types that you want to see. Currently, <code>BayesianInference</code> is the only valid value.</p>
pub fn get_report_names(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ExperimentReportName>> {
&self.report_names
}
/// <p>In seconds, the amount of time to aggregate results together.</p>
pub fn period(mut self, input: i64) -> Self {
self.period = ::std::option::Option::Some(input);
self
}
/// <p>In seconds, the amount of time to aggregate results together.</p>
pub fn set_period(mut self, input: ::std::option::Option<i64>) -> Self {
self.period = input;
self
}
/// <p>In seconds, the amount of time to aggregate results together.</p>
pub fn get_period(&self) -> &::std::option::Option<i64> {
&self.period
}
/// Consumes the builder and constructs a [`GetExperimentResultsInput`](crate::operation::get_experiment_results::GetExperimentResultsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::get_experiment_results::GetExperimentResultsInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::get_experiment_results::GetExperimentResultsInput {
project: self.project,
experiment: self.experiment,
start_time: self.start_time,
end_time: self.end_time,
metric_names: self.metric_names,
treatment_names: self.treatment_names,
base_stat: self.base_stat,
result_stats: self.result_stats,
report_names: self.report_names,
period: self.period,
})
}
}