aws_sdk_sagemaker/client/
list_pipeline_execution_steps.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 [`ListPipelineExecutionSteps`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`pipeline_execution_arn(impl Into<String>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::pipeline_execution_arn) / [`set_pipeline_execution_arn(Option<String>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::set_pipeline_execution_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the pipeline execution.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListPipelineExecutionSteps</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline execution steps, use the token in the next request.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of pipeline execution steps to return in the response.</p><br>
10    ///   - [`sort_order(SortOrder)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The field by which to sort results. The default is <code>CreatedTime</code>.</p><br>
11    /// - On success, responds with [`ListPipelineExecutionStepsOutput`](crate::operation::list_pipeline_execution_steps::ListPipelineExecutionStepsOutput) with field(s):
12    ///   - [`pipeline_execution_steps(Option<Vec::<PipelineExecutionStep>>)`](crate::operation::list_pipeline_execution_steps::ListPipelineExecutionStepsOutput::pipeline_execution_steps): <p>A list of <code>PipeLineExecutionStep</code> objects. Each <code>PipeLineExecutionStep</code> consists of StepName, StartTime, EndTime, StepStatus, and Metadata. Metadata is an object with properties for each job that contains relevant information about the job created by the step.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_pipeline_execution_steps::ListPipelineExecutionStepsOutput::next_token): <p>If the result of the previous <code>ListPipelineExecutionSteps</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline execution steps, use the token in the next request.</p>
14    /// - On failure, responds with [`SdkError<ListPipelineExecutionStepsError>`](crate::operation::list_pipeline_execution_steps::ListPipelineExecutionStepsError)
15    pub fn list_pipeline_execution_steps(
16        &self,
17    ) -> crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder {
18        crate::operation::list_pipeline_execution_steps::builders::ListPipelineExecutionStepsFluentBuilder::new(self.handle.clone())
19    }
20}