aws_sdk_sagemaker/client/create_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 [`CreateExperiment`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`experiment_name(impl Into<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::experiment_name) / [`set_experiment_name(Option<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::set_experiment_name):<br>required: **true**<br><p>The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.</p><br>
7 /// - [`display_name(impl Into<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::set_display_name):<br>required: **false**<br><p>The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify <code>DisplayName</code>, the value in <code>ExperimentName</code> is displayed.</p><br>
8 /// - [`description(impl Into<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::set_description):<br>required: **false**<br><p>The description of the experiment.</p><br>
9 /// - [`tags(Tag)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::set_tags):<br>required: **false**<br><p>A list of tags to associate with the experiment. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</p><br>
10 /// - On success, responds with [`CreateExperimentOutput`](crate::operation::create_experiment::CreateExperimentOutput) with field(s):
11 /// - [`experiment_arn(Option<String>)`](crate::operation::create_experiment::CreateExperimentOutput::experiment_arn): <p>The Amazon Resource Name (ARN) of the experiment.</p>
12 /// - On failure, responds with [`SdkError<CreateExperimentError>`](crate::operation::create_experiment::CreateExperimentError)
13 pub fn create_experiment(&self) -> crate::operation::create_experiment::builders::CreateExperimentFluentBuilder {
14 crate::operation::create_experiment::builders::CreateExperimentFluentBuilder::new(self.handle.clone())
15 }
16}