aws_sdk_evidently/operation/update_experiment/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_experiment::_update_experiment_output::UpdateExperimentOutputBuilder;
3
4pub use crate::operation::update_experiment::_update_experiment_input::UpdateExperimentInputBuilder;
5
6impl crate::operation::update_experiment::builders::UpdateExperimentInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::update_experiment::UpdateExperimentOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_experiment::UpdateExperimentError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_experiment();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateExperiment`.
24///
25/// <p>Updates an Evidently experiment.</p>
26/// <p>Don't use this operation to update an experiment's tag. Instead, use <a href="https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
27#[deprecated(note = "AWS CloudWatch Evidently has been deprecated since 11/17/2025.", since = "11/17/2025")]
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateExperimentFluentBuilder {
30 handle: ::std::sync::Arc<crate::client::Handle>,
31 inner: crate::operation::update_experiment::builders::UpdateExperimentInputBuilder,
32 config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35 crate::client::customize::internal::CustomizableSend<
36 crate::operation::update_experiment::UpdateExperimentOutput,
37 crate::operation::update_experiment::UpdateExperimentError,
38 > for UpdateExperimentFluentBuilder
39{
40 fn send(
41 self,
42 config_override: crate::config::Builder,
43 ) -> crate::client::customize::internal::BoxFuture<
44 crate::client::customize::internal::SendResult<
45 crate::operation::update_experiment::UpdateExperimentOutput,
46 crate::operation::update_experiment::UpdateExperimentError,
47 >,
48 > {
49 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50 }
51}
52impl UpdateExperimentFluentBuilder {
53 /// Creates a new `UpdateExperimentFluentBuilder`.
54 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55 Self {
56 handle,
57 inner: ::std::default::Default::default(),
58 config_override: ::std::option::Option::None,
59 }
60 }
61 /// Access the UpdateExperiment as a reference.
62 pub fn as_input(&self) -> &crate::operation::update_experiment::builders::UpdateExperimentInputBuilder {
63 &self.inner
64 }
65 /// Sends the request and returns the response.
66 ///
67 /// If an error occurs, an `SdkError` will be returned with additional details that
68 /// can be matched against.
69 ///
70 /// By default, any retryable failures will be retried twice. Retry behavior
71 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72 /// set when configuring the client.
73 pub async fn send(
74 self,
75 ) -> ::std::result::Result<
76 crate::operation::update_experiment::UpdateExperimentOutput,
77 ::aws_smithy_runtime_api::client::result::SdkError<
78 crate::operation::update_experiment::UpdateExperimentError,
79 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80 >,
81 > {
82 let input = self
83 .inner
84 .build()
85 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86 let runtime_plugins = crate::operation::update_experiment::UpdateExperiment::operation_runtime_plugins(
87 self.handle.runtime_plugins.clone(),
88 &self.handle.conf,
89 self.config_override,
90 );
91 crate::operation::update_experiment::UpdateExperiment::orchestrate(&runtime_plugins, input).await
92 }
93
94 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95 pub fn customize(
96 self,
97 ) -> crate::client::customize::CustomizableOperation<
98 crate::operation::update_experiment::UpdateExperimentOutput,
99 crate::operation::update_experiment::UpdateExperimentError,
100 Self,
101 > {
102 crate::client::customize::CustomizableOperation::new(self)
103 }
104 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105 self.set_config_override(::std::option::Option::Some(config_override.into()));
106 self
107 }
108
109 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110 self.config_override = config_override;
111 self
112 }
113 /// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
114 pub fn project(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115 self.inner = self.inner.project(input.into());
116 self
117 }
118 /// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
119 pub fn set_project(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120 self.inner = self.inner.set_project(input);
121 self
122 }
123 /// <p>The name or ARN of the project that contains the experiment that you want to update.</p>
124 pub fn get_project(&self) -> &::std::option::Option<::std::string::String> {
125 self.inner.get_project()
126 }
127 /// <p>The name of the experiment to update.</p>
128 pub fn experiment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
129 self.inner = self.inner.experiment(input.into());
130 self
131 }
132 /// <p>The name of the experiment to update.</p>
133 pub fn set_experiment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
134 self.inner = self.inner.set_experiment(input);
135 self
136 }
137 /// <p>The name of the experiment to update.</p>
138 pub fn get_experiment(&self) -> &::std::option::Option<::std::string::String> {
139 self.inner.get_experiment()
140 }
141 /// <p>An optional description of the experiment.</p>
142 pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
143 self.inner = self.inner.description(input.into());
144 self
145 }
146 /// <p>An optional description of the experiment.</p>
147 pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
148 self.inner = self.inner.set_description(input);
149 self
150 }
151 /// <p>An optional description of the experiment.</p>
152 pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
153 self.inner.get_description()
154 }
155 ///
156 /// Appends an item to `treatments`.
157 ///
158 /// To override the contents of this collection use [`set_treatments`](Self::set_treatments).
159 ///
160 /// <p>An array of structures that define the variations being tested in the experiment.</p>
161 pub fn treatments(mut self, input: crate::types::TreatmentConfig) -> Self {
162 self.inner = self.inner.treatments(input);
163 self
164 }
165 /// <p>An array of structures that define the variations being tested in the experiment.</p>
166 pub fn set_treatments(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>>) -> Self {
167 self.inner = self.inner.set_treatments(input);
168 self
169 }
170 /// <p>An array of structures that define the variations being tested in the experiment.</p>
171 pub fn get_treatments(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TreatmentConfig>> {
172 self.inner.get_treatments()
173 }
174 ///
175 /// Appends an item to `metricGoals`.
176 ///
177 /// To override the contents of this collection use [`set_metric_goals`](Self::set_metric_goals).
178 ///
179 /// <p>An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.</p>
180 pub fn metric_goals(mut self, input: crate::types::MetricGoalConfig) -> Self {
181 self.inner = self.inner.metric_goals(input);
182 self
183 }
184 /// <p>An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.</p>
185 pub fn set_metric_goals(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>>) -> Self {
186 self.inner = self.inner.set_metric_goals(input);
187 self
188 }
189 /// <p>An array of structures that defines the metrics used for the experiment, and whether a higher or lower value for each metric is the goal.</p>
190 pub fn get_metric_goals(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::MetricGoalConfig>> {
191 self.inner.get_metric_goals()
192 }
193 /// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
194 pub fn randomization_salt(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
195 self.inner = self.inner.randomization_salt(input.into());
196 self
197 }
198 /// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
199 pub fn set_randomization_salt(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
200 self.inner = self.inner.set_randomization_salt(input);
201 self
202 }
203 /// <p>When Evidently assigns a particular user session to an experiment, it must use a randomization ID to determine which variation the user session is served. This randomization ID is a combination of the entity ID and <code>randomizationSalt</code>. If you omit <code>randomizationSalt</code>, Evidently uses the experiment name as the <code>randomizationSalt</code>.</p>
204 pub fn get_randomization_salt(&self) -> &::std::option::Option<::std::string::String> {
205 self.inner.get_randomization_salt()
206 }
207 /// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
208 /// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
209 pub fn sampling_rate(mut self, input: i64) -> Self {
210 self.inner = self.inner.sampling_rate(input);
211 self
212 }
213 /// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
214 /// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
215 pub fn set_sampling_rate(mut self, input: ::std::option::Option<i64>) -> Self {
216 self.inner = self.inner.set_sampling_rate(input);
217 self
218 }
219 /// <p>The portion of the available audience that you want to allocate to this experiment, in thousandths of a percent. The available audience is the total audience minus the audience that you have allocated to overrides or current launches of this feature.</p>
220 /// <p>This is represented in thousandths of a percent. For example, specify 20,000 to allocate 20% of the available audience.</p>
221 pub fn get_sampling_rate(&self) -> &::std::option::Option<i64> {
222 self.inner.get_sampling_rate()
223 }
224 /// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
225 pub fn segment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
226 self.inner = self.inner.segment(input.into());
227 self
228 }
229 /// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
230 pub fn set_segment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
231 self.inner = self.inner.set_segment(input);
232 self
233 }
234 /// <p>Adds an audience <i>segment</i> to an experiment. When a segment is used in an experiment, only user sessions that match the segment pattern are used in the experiment. You can't use this parameter if the experiment is currently running.</p>
235 pub fn get_segment(&self) -> &::std::option::Option<::std::string::String> {
236 self.inner.get_segment()
237 }
238 /// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
239 pub fn remove_segment(mut self, input: bool) -> Self {
240 self.inner = self.inner.remove_segment(input);
241 self
242 }
243 /// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
244 pub fn set_remove_segment(mut self, input: ::std::option::Option<bool>) -> Self {
245 self.inner = self.inner.set_remove_segment(input);
246 self
247 }
248 /// <p>Removes a segment from being used in an experiment. You can't use this parameter if the experiment is currently running.</p>
249 pub fn get_remove_segment(&self) -> &::std::option::Option<bool> {
250 self.inner.get_remove_segment()
251 }
252 /// <p>A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.</p>
253 pub fn online_ab_config(mut self, input: crate::types::OnlineAbConfig) -> Self {
254 self.inner = self.inner.online_ab_config(input);
255 self
256 }
257 /// <p>A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.</p>
258 pub fn set_online_ab_config(mut self, input: ::std::option::Option<crate::types::OnlineAbConfig>) -> Self {
259 self.inner = self.inner.set_online_ab_config(input);
260 self
261 }
262 /// <p>A structure that contains the configuration of which variation o use as the "control" version. The "control" version is used for comparison with other variations. This structure also specifies how much experiment traffic is allocated to each variation.</p>
263 pub fn get_online_ab_config(&self) -> &::std::option::Option<crate::types::OnlineAbConfig> {
264 self.inner.get_online_ab_config()
265 }
266}