aws_sdk_sagemaker/client/create_trial.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 [`CreateTrial`](crate::operation::create_trial::builders::CreateTrialFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`trial_name(impl Into<String>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::trial_name) / [`set_trial_name(Option<String>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::set_trial_name):<br>required: **true**<br><p>The name of the trial. 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_trial::builders::CreateTrialFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::set_display_name):<br>required: **false**<br><p>The name of the trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p><br>
8 /// - [`experiment_name(impl Into<String>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::experiment_name) / [`set_experiment_name(Option<String>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::set_experiment_name):<br>required: **true**<br><p>The name of the experiment to associate the trial with.</p><br>
9 /// - [`metadata_properties(MetadataProperties)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::metadata_properties) / [`set_metadata_properties(Option<MetadataProperties>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::set_metadata_properties):<br>required: **false**<br><p>Metadata properties of the tracking entity, trial, or trial component.</p><br>
10 /// - [`tags(Tag)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_trial::builders::CreateTrialFluentBuilder::set_tags):<br>required: **false**<br><p>A list of tags to associate with the trial. 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>
11 /// - On success, responds with [`CreateTrialOutput`](crate::operation::create_trial::CreateTrialOutput) with field(s):
12 /// - [`trial_arn(Option<String>)`](crate::operation::create_trial::CreateTrialOutput::trial_arn): <p>The Amazon Resource Name (ARN) of the trial.</p>
13 /// - On failure, responds with [`SdkError<CreateTrialError>`](crate::operation::create_trial::CreateTrialError)
14 pub fn create_trial(&self) -> crate::operation::create_trial::builders::CreateTrialFluentBuilder {
15 crate::operation::create_trial::builders::CreateTrialFluentBuilder::new(self.handle.clone())
16 }
17}