aws_sdk_mwaaserverless/client/
list_workflow_runs.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 [`ListWorkflowRuns`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of workflow runs to return in a single response.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to <code>ListWorkflowRuns</code>.</p><br>
9    ///   - [`workflow_arn(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.</p><br>
10    ///   - [`workflow_version(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::workflow_version) / [`set_workflow_version(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_workflow_version):<br>required: **false**<br><p>Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.</p><br>
11    /// - On success, responds with [`ListWorkflowRunsOutput`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput) with field(s):
12    ///   - [`workflow_runs(Option<Vec::<WorkflowRunSummary>>)`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput::workflow_runs): <p>A list of workflow run summaries for the specified workflow.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput::next_token): <p>The pagination token you need to use to retrieve the next set of results. This value is null if there are no more results.</p>
14    /// - On failure, responds with [`SdkError<ListWorkflowRunsError>`](crate::operation::list_workflow_runs::ListWorkflowRunsError)
15    pub fn list_workflow_runs(&self) -> crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder {
16        crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::new(self.handle.clone())
17    }
18}