aws_sdk_sagemaker/client/
describe_pipeline_execution.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 [`DescribePipelineExecution`](crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`pipeline_execution_arn(impl Into<String>)`](crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionFluentBuilder::pipeline_execution_arn) / [`set_pipeline_execution_arn(Option<String>)`](crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionFluentBuilder::set_pipeline_execution_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the pipeline execution.</p><br>
7    /// - On success, responds with [`DescribePipelineExecutionOutput`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput) with field(s):
8    ///   - [`pipeline_arn(Option<String>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_arn): <p>The Amazon Resource Name (ARN) of the pipeline.</p>
9    ///   - [`pipeline_execution_arn(Option<String>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_execution_arn): <p>The Amazon Resource Name (ARN) of the pipeline execution.</p>
10    ///   - [`pipeline_execution_display_name(Option<String>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_execution_display_name): <p>The display name of the pipeline execution.</p>
11    ///   - [`pipeline_execution_status(Option<PipelineExecutionStatus>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_execution_status): <p>The status of the pipeline execution.</p>
12    ///   - [`pipeline_execution_description(Option<String>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_execution_description): <p>The description of the pipeline execution.</p>
13    ///   - [`pipeline_experiment_config(Option<PipelineExperimentConfig>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::pipeline_experiment_config): <p>Specifies the names of the experiment and trial created by a pipeline.</p>
14    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::failure_reason): <p>If the execution failed, a message describing why.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::creation_time): <p>The time when the pipeline execution was created.</p>
16    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::last_modified_time): <p>The time when the pipeline execution was modified last.</p>
17    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::created_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
18    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::last_modified_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
19    ///   - [`parallelism_configuration(Option<ParallelismConfiguration>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::parallelism_configuration): <p>The parallelism configuration applied to the pipeline.</p>
20    ///   - [`selective_execution_config(Option<SelectiveExecutionConfig>)`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionOutput::selective_execution_config): <p>The selective execution configuration applied to the pipeline run.</p>
21    /// - On failure, responds with [`SdkError<DescribePipelineExecutionError>`](crate::operation::describe_pipeline_execution::DescribePipelineExecutionError)
22    pub fn describe_pipeline_execution(&self) -> crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionFluentBuilder {
23        crate::operation::describe_pipeline_execution::builders::DescribePipelineExecutionFluentBuilder::new(self.handle.clone())
24    }
25}