aws_sdk_sagemaker/client/
describe_pipeline.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 [`DescribePipeline`](crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`pipeline_name(impl Into<String>)`](crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder::pipeline_name) / [`set_pipeline_name(Option<String>)`](crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder::set_pipeline_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the pipeline to describe.</p><br>
7    ///   - [`pipeline_version_id(i64)`](crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder::pipeline_version_id) / [`set_pipeline_version_id(Option<i64>)`](crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder::set_pipeline_version_id):<br>required: **false**<br><p>The ID of the pipeline version to describe.</p><br>
8    /// - On success, responds with [`DescribePipelineOutput`](crate::operation::describe_pipeline::DescribePipelineOutput) with field(s):
9    ///   - [`pipeline_arn(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_arn): <p>The Amazon Resource Name (ARN) of the pipeline.</p>
10    ///   - [`pipeline_name(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_name): <p>The name of the pipeline.</p>
11    ///   - [`pipeline_display_name(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_display_name): <p>The display name of the pipeline.</p>
12    ///   - [`pipeline_definition(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_definition): <p>The JSON pipeline definition.</p>
13    ///   - [`pipeline_description(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_description): <p>The description of the pipeline.</p>
14    ///   - [`role_arn(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::role_arn): <p>The Amazon Resource Name (ARN) that the pipeline uses to execute.</p>
15    ///   - [`pipeline_status(Option<PipelineStatus>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_status): <p>The status of the pipeline execution.</p>
16    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_pipeline::DescribePipelineOutput::creation_time): <p>The time when the pipeline was created.</p>
17    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_pipeline::DescribePipelineOutput::last_modified_time): <p>The time when the pipeline was last modified.</p>
18    ///   - [`last_run_time(Option<DateTime>)`](crate::operation::describe_pipeline::DescribePipelineOutput::last_run_time): <p>The time when the pipeline was last run.</p>
19    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_pipeline::DescribePipelineOutput::created_by): <p>Information about the user who created or modified a SageMaker resource.</p>
20    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_pipeline::DescribePipelineOutput::last_modified_by): <p>Information about the user who created or modified a SageMaker resource.</p>
21    ///   - [`parallelism_configuration(Option<ParallelismConfiguration>)`](crate::operation::describe_pipeline::DescribePipelineOutput::parallelism_configuration): <p>Lists the parallelism configuration applied to the pipeline.</p>
22    ///   - [`pipeline_version_display_name(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_version_display_name): <p>The display name of the pipeline version.</p>
23    ///   - [`pipeline_version_description(Option<String>)`](crate::operation::describe_pipeline::DescribePipelineOutput::pipeline_version_description): <p>The description of the pipeline version.</p>
24    /// - On failure, responds with [`SdkError<DescribePipelineError>`](crate::operation::describe_pipeline::DescribePipelineError)
25    pub fn describe_pipeline(&self) -> crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder {
26        crate::operation::describe_pipeline::builders::DescribePipelineFluentBuilder::new(self.handle.clone())
27    }
28}
aws_sdk_sagemaker/client/describe_pipeline.rs

aws_sdk_sagemaker/client/
describe_pipeline.rs
