aws_sdk_sagemaker/client/
create_trial_component.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 [`CreateTrialComponent`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`trial_component_name(impl Into<String>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::trial_component_name) / [`set_trial_component_name(Option<String>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_trial_component_name):<br>required: **true**<br><p>The name of the component. 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_component::builders::CreateTrialComponentFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_display_name):<br>required: **false**<br><p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p><br>
8    ///   - [`status(TrialComponentStatus)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::status) / [`set_status(Option<TrialComponentStatus>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_status):<br>required: **false**<br><p>The status of the component. States include:</p> <ul>  <li>   <p>InProgress</p></li>  <li>   <p>Completed</p></li>  <li>   <p>Failed</p></li> </ul><br>
9    ///   - [`start_time(DateTime)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_start_time):<br>required: **false**<br><p>When the component started.</p><br>
10    ///   - [`end_time(DateTime)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_end_time):<br>required: **false**<br><p>When the component ended.</p><br>
11    ///   - [`parameters(impl Into<String>, TrialComponentParameterValue)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::parameters) / [`set_parameters(Option<HashMap::<String, TrialComponentParameterValue>>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_parameters):<br>required: **false**<br><p>The hyperparameters for the component.</p><br>
12    ///   - [`input_artifacts(impl Into<String>, TrialComponentArtifact)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::input_artifacts) / [`set_input_artifacts(Option<HashMap::<String, TrialComponentArtifact>>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_input_artifacts):<br>required: **false**<br><p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p><br>
13    ///   - [`output_artifacts(impl Into<String>, TrialComponentArtifact)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::output_artifacts) / [`set_output_artifacts(Option<HashMap::<String, TrialComponentArtifact>>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_output_artifacts):<br>required: **false**<br><p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p><br>
14    ///   - [`metadata_properties(MetadataProperties)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::metadata_properties) / [`set_metadata_properties(Option<MetadataProperties>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_metadata_properties):<br>required: **false**<br><p>Metadata properties of the tracking entity, trial, or trial component.</p><br>
15    ///   - [`tags(Tag)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::set_tags):<br>required: **false**<br><p>A list of tags to associate with the component. 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>
16    /// - On success, responds with [`CreateTrialComponentOutput`](crate::operation::create_trial_component::CreateTrialComponentOutput) with field(s):
17    ///   - [`trial_component_arn(Option<String>)`](crate::operation::create_trial_component::CreateTrialComponentOutput::trial_component_arn): <p>The Amazon Resource Name (ARN) of the trial component.</p>
18    /// - On failure, responds with [`SdkError<CreateTrialComponentError>`](crate::operation::create_trial_component::CreateTrialComponentError)
19    pub fn create_trial_component(&self) -> crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder {
20        crate::operation::create_trial_component::builders::CreateTrialComponentFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_sagemaker/client/create_trial_component.rs

aws_sdk_sagemaker/client/
create_trial_component.rs
