aws_sdk_sagemaker/client/
describe_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 [`DescribeTrialComponent`](crate::operation::describe_trial_component::builders::DescribeTrialComponentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`trial_component_name(impl Into<String>)`](crate::operation::describe_trial_component::builders::DescribeTrialComponentFluentBuilder::trial_component_name) / [`set_trial_component_name(Option<String>)`](crate::operation::describe_trial_component::builders::DescribeTrialComponentFluentBuilder::set_trial_component_name):<br>required: **true**<br><p>The name of the trial component to describe.</p><br>
7    /// - On success, responds with [`DescribeTrialComponentOutput`](crate::operation::describe_trial_component::DescribeTrialComponentOutput) with field(s):
8    ///   - [`trial_component_name(Option<String>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::trial_component_name): <p>The name of the trial component.</p>
9    ///   - [`trial_component_arn(Option<String>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::trial_component_arn): <p>The Amazon Resource Name (ARN) of the trial component.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::display_name): <p>The name of the component as displayed. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>
11    ///   - [`source(Option<TrialComponentSource>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::source): <p>The Amazon Resource Name (ARN) of the source and, optionally, the job type.</p>
12    ///   - [`status(Option<TrialComponentStatus>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::status): <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>
13    ///   - [`start_time(Option<DateTime>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::start_time): <p>When the component started.</p>
14    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::end_time): <p>When the component ended.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::creation_time): <p>When the component was created.</p>
16    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::created_by): <p>Who created the trial component.</p>
17    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::last_modified_time): <p>When the component was last modified.</p>
18    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::last_modified_by): <p>Who last modified the component.</p>
19    ///   - [`parameters(Option<HashMap::<String, TrialComponentParameterValue>>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::parameters): <p>The hyperparameters of the component.</p>
20    ///   - [`input_artifacts(Option<HashMap::<String, TrialComponentArtifact>>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::input_artifacts): <p>The input artifacts of the component.</p>
21    ///   - [`output_artifacts(Option<HashMap::<String, TrialComponentArtifact>>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::output_artifacts): <p>The output artifacts of the component.</p>
22    ///   - [`metadata_properties(Option<MetadataProperties>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::metadata_properties): <p>Metadata properties of the tracking entity, trial, or trial component.</p>
23    ///   - [`metrics(Option<Vec::<TrialComponentMetricSummary>>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::metrics): <p>The metrics for the component.</p>
24    ///   - [`lineage_group_arn(Option<String>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::lineage_group_arn): <p>The Amazon Resource Name (ARN) of the lineage group.</p>
25    ///   - [`sources(Option<Vec::<TrialComponentSource>>)`](crate::operation::describe_trial_component::DescribeTrialComponentOutput::sources): <p>A list of ARNs and, if applicable, job types for multiple sources of an experiment run.</p>
26    /// - On failure, responds with [`SdkError<DescribeTrialComponentError>`](crate::operation::describe_trial_component::DescribeTrialComponentError)
27    pub fn describe_trial_component(&self) -> crate::operation::describe_trial_component::builders::DescribeTrialComponentFluentBuilder {
28        crate::operation::describe_trial_component::builders::DescribeTrialComponentFluentBuilder::new(self.handle.clone())
29    }
30}
aws_sdk_sagemaker/client/describe_trial_component.rs

aws_sdk_sagemaker/client/
describe_trial_component.rs
