aws_sdk_sagemaker/client/list_pipeline_executions.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 [`ListPipelineExecutions`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`pipeline_name(impl Into<String>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::pipeline_name) / [`set_pipeline_name(Option<String>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_pipeline_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the pipeline.</p><br>
8 /// - [`created_after(DateTime)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::created_after) / [`set_created_after(Option<DateTime>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_created_after):<br>required: **false**<br><p>A filter that returns the pipeline executions that were created after a specified time.</p><br>
9 /// - [`created_before(DateTime)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::created_before) / [`set_created_before(Option<DateTime>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_created_before):<br>required: **false**<br><p>A filter that returns the pipeline executions that were created before a specified time.</p><br>
10 /// - [`sort_by(SortPipelineExecutionsBy)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::sort_by) / [`set_sort_by(Option<SortPipelineExecutionsBy>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field by which to sort results. The default is <code>CreatedTime</code>.</p><br>
11 /// - [`sort_order(SortOrder)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results.</p><br>
12 /// - [`next_token(impl Into<String>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListPipelineExecutions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline executions, use the token in the next request.</p><br>
13 /// - [`max_results(i32)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of pipeline executions to return in the response.</p><br>
14 /// - On success, responds with [`ListPipelineExecutionsOutput`](crate::operation::list_pipeline_executions::ListPipelineExecutionsOutput) with field(s):
15 /// - [`pipeline_execution_summaries(Option<Vec::<PipelineExecutionSummary>>)`](crate::operation::list_pipeline_executions::ListPipelineExecutionsOutput::pipeline_execution_summaries): <p>Contains a sorted list of pipeline execution summary objects matching the specified filters. Each run summary includes the Amazon Resource Name (ARN) of the pipeline execution, the run date, and the status. This list can be empty.</p>
16 /// - [`next_token(Option<String>)`](crate::operation::list_pipeline_executions::ListPipelineExecutionsOutput::next_token): <p>If the result of the previous <code>ListPipelineExecutions</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of pipeline executions, use the token in the next request.</p>
17 /// - On failure, responds with [`SdkError<ListPipelineExecutionsError>`](crate::operation::list_pipeline_executions::ListPipelineExecutionsError)
18 pub fn list_pipeline_executions(&self) -> crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder {
19 crate::operation::list_pipeline_executions::builders::ListPipelineExecutionsFluentBuilder::new(self.handle.clone())
20 }
21}