aws_sdk_sagemaker/client/describe_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 [`DescribeExperiment`](crate::operation::describe_experiment::builders::DescribeExperimentFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`experiment_name(impl Into<String>)`](crate::operation::describe_experiment::builders::DescribeExperimentFluentBuilder::experiment_name) / [`set_experiment_name(Option<String>)`](crate::operation::describe_experiment::builders::DescribeExperimentFluentBuilder::set_experiment_name):<br>required: **true**<br><p>The name of the experiment to describe.</p><br>
7 /// - On success, responds with [`DescribeExperimentOutput`](crate::operation::describe_experiment::DescribeExperimentOutput) with field(s):
8 /// - [`experiment_name(Option<String>)`](crate::operation::describe_experiment::DescribeExperimentOutput::experiment_name): <p>The name of the experiment.</p>
9 /// - [`experiment_arn(Option<String>)`](crate::operation::describe_experiment::DescribeExperimentOutput::experiment_arn): <p>The Amazon Resource Name (ARN) of the experiment.</p>
10 /// - [`display_name(Option<String>)`](crate::operation::describe_experiment::DescribeExperimentOutput::display_name): <p>The name of the experiment as displayed. If <code>DisplayName</code> isn't specified, <code>ExperimentName</code> is displayed.</p>
11 /// - [`source(Option<ExperimentSource>)`](crate::operation::describe_experiment::DescribeExperimentOutput::source): <p>The Amazon Resource Name (ARN) of the source and, optionally, the type.</p>
12 /// - [`description(Option<String>)`](crate::operation::describe_experiment::DescribeExperimentOutput::description): <p>The description of the experiment.</p>
13 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_experiment::DescribeExperimentOutput::creation_time): <p>When the experiment was created.</p>
14 /// - [`created_by(Option<UserContext>)`](crate::operation::describe_experiment::DescribeExperimentOutput::created_by): <p>Who created the experiment.</p>
15 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_experiment::DescribeExperimentOutput::last_modified_time): <p>When the experiment was last modified.</p>
16 /// - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_experiment::DescribeExperimentOutput::last_modified_by): <p>Who last modified the experiment.</p>
17 /// - On failure, responds with [`SdkError<DescribeExperimentError>`](crate::operation::describe_experiment::DescribeExperimentError)
18 pub fn describe_experiment(&self) -> crate::operation::describe_experiment::builders::DescribeExperimentFluentBuilder {
19 crate::operation::describe_experiment::builders::DescribeExperimentFluentBuilder::new(self.handle.clone())
20 }
21}