aws_sdk_codecatalyst/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    ///   - [`space_name(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::space_name) / [`set_space_name(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_space_name):<br>required: **true**<br><p>The name of the space.</p><br>
8    ///   - [`workflow_id(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_workflow_id):<br>required: **false**<br><p>The ID of the workflow. To retrieve a list of workflow IDs, use <code>ListWorkflows</code>.</p><br>
9    ///   - [`project_name(impl Into<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::project_name) / [`set_project_name(Option<String>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_project_name):<br>required: **true**<br><p>The name of the project in the space.</p><br>
10    ///   - [`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>A token returned from a call to this API to indicate the next batch of results to return, if any.</p><br>
11    ///   - [`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 results to show in a single call to this API. If the number of results is larger than the number you specified, the response will include a <code>NextToken</code> element, which you can use to obtain additional results.</p><br>
12    ///   - [`sort_by(WorkflowRunSortCriteria)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::sort_by) / [`set_sort_by(Option<Vec::<WorkflowRunSortCriteria>>)`](crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::set_sort_by):<br>required: **false**<br><p>Information used to sort the items in the returned list.</p><br>
13    /// - On success, responds with [`ListWorkflowRunsOutput`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput) with field(s):
14    ///   - [`next_token(Option<String>)`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput::next_token): <p>A token returned from a call to this API to indicate the next batch of results to return, if any.</p>
15    ///   - [`items(Option<Vec::<WorkflowRunSummary>>)`](crate::operation::list_workflow_runs::ListWorkflowRunsOutput::items): <p>Information about the runs of a workflow.</p>
16    /// - On failure, responds with [`SdkError<ListWorkflowRunsError>`](crate::operation::list_workflow_runs::ListWorkflowRunsError)
17    pub fn list_workflow_runs(&self) -> crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder {
18        crate::operation::list_workflow_runs::builders::ListWorkflowRunsFluentBuilder::new(self.handle.clone())
19    }
20}
aws_sdk_codecatalyst/client/list_workflow_runs.rs

aws_sdk_codecatalyst/client/
list_workflow_runs.rs
