aws_sdk_evidently/client/
stop_experiment.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StopExperiment`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`project(impl Into<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::project) / [`set_project(Option<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::set_project):<br>required: **true**<br><p>The name or ARN of the project that contains the experiment to stop.</p><br>
7    ///   - [`experiment(impl Into<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::experiment) / [`set_experiment(Option<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::set_experiment):<br>required: **true**<br><p>The name of the experiment to stop.</p><br>
8    ///   - [`desired_state(ExperimentStopDesiredState)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::desired_state) / [`set_desired_state(Option<ExperimentStopDesiredState>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::set_desired_state):<br>required: **false**<br><p>Specify whether the experiment is to be considered <code>COMPLETED</code> or <code>CANCELLED</code> after it stops.</p><br>
9    ///   - [`reason(impl Into<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::reason) / [`set_reason(Option<String>)`](crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::set_reason):<br>required: **false**<br><p>A string that describes why you are stopping the experiment.</p><br>
10    /// - On success, responds with [`StopExperimentOutput`](crate::operation::stop_experiment::StopExperimentOutput) with field(s):
11    ///   - [`ended_time(Option<DateTime>)`](crate::operation::stop_experiment::StopExperimentOutput::ended_time): <p>The date and time that the experiment stopped.</p>
12    /// - On failure, responds with [`SdkError<StopExperimentError>`](crate::operation::stop_experiment::StopExperimentError)
13    pub fn stop_experiment(&self) -> crate::operation::stop_experiment::builders::StopExperimentFluentBuilder {
14        crate::operation::stop_experiment::builders::StopExperimentFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_evidently/client/stop_experiment.rs

aws_sdk_evidently/client/
stop_experiment.rs
