aws_sdk_sagemaker/client/
describe_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 [`DescribeTrial`](crate::operation::describe_trial::builders::DescribeTrialFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`trial_name(impl Into<String>)`](crate::operation::describe_trial::builders::DescribeTrialFluentBuilder::trial_name) / [`set_trial_name(Option<String>)`](crate::operation::describe_trial::builders::DescribeTrialFluentBuilder::set_trial_name):<br>required: **true**<br><p>The name of the trial to describe.</p><br>
7    /// - On success, responds with [`DescribeTrialOutput`](crate::operation::describe_trial::DescribeTrialOutput) with field(s):
8    ///   - [`trial_name(Option<String>)`](crate::operation::describe_trial::DescribeTrialOutput::trial_name): <p>The name of the trial.</p>
9    ///   - [`trial_arn(Option<String>)`](crate::operation::describe_trial::DescribeTrialOutput::trial_arn): <p>The Amazon Resource Name (ARN) of the trial.</p>
10    ///   - [`display_name(Option<String>)`](crate::operation::describe_trial::DescribeTrialOutput::display_name): <p>The name of the trial as displayed. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>
11    ///   - [`experiment_name(Option<String>)`](crate::operation::describe_trial::DescribeTrialOutput::experiment_name): <p>The name of the experiment the trial is part of.</p>
12    ///   - [`source(Option<TrialSource>)`](crate::operation::describe_trial::DescribeTrialOutput::source): <p>The Amazon Resource Name (ARN) of the source and, optionally, the job type.</p>
13    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_trial::DescribeTrialOutput::creation_time): <p>When the trial was created.</p>
14    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_trial::DescribeTrialOutput::created_by): <p>Who created the trial.</p>
15    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_trial::DescribeTrialOutput::last_modified_time): <p>When the trial was last modified.</p>
16    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_trial::DescribeTrialOutput::last_modified_by): <p>Who last modified the trial.</p>
17    ///   - [`metadata_properties(Option<MetadataProperties>)`](crate::operation::describe_trial::DescribeTrialOutput::metadata_properties): <p>Metadata properties of the tracking entity, trial, or trial component.</p>
18    /// - On failure, responds with [`SdkError<DescribeTrialError>`](crate::operation::describe_trial::DescribeTrialError)
19    pub fn describe_trial(&self) -> crate::operation::describe_trial::builders::DescribeTrialFluentBuilder {
20        crate::operation::describe_trial::builders::DescribeTrialFluentBuilder::new(self.handle.clone())
21    }
22}
aws_sdk_sagemaker/client/describe_trial.rs

aws_sdk_sagemaker/client/
describe_trial.rs
