aws_sdk_mwaaserverless/client/
list_task_instances.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 [`ListTaskInstances`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workflow_arn(impl Into<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::workflow_arn) / [`set_workflow_arn(Option<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::set_workflow_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the workflow that contains the run.</p><br>
8    ///   - [`run_id(impl Into<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::run_id) / [`set_run_id(Option<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::set_run_id):<br>required: **true**<br><p>The unique identifier of the workflow run for which you want a list of task instances.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of task instances to return in a single response.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::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>ListTaskInstances</code>.</p><br>
11    /// - On success, responds with [`ListTaskInstancesOutput`](crate::operation::list_task_instances::ListTaskInstancesOutput) with field(s):
12    ///   - [`task_instances(Option<Vec::<TaskInstanceSummary>>)`](crate::operation::list_task_instances::ListTaskInstancesOutput::task_instances): <p>A list of task instance summaries for the specified workflow run.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_task_instances::ListTaskInstancesOutput::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<ListTaskInstancesError>`](crate::operation::list_task_instances::ListTaskInstancesError)
15    pub fn list_task_instances(&self) -> crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder {
16        crate::operation::list_task_instances::builders::ListTaskInstancesFluentBuilder::new(self.handle.clone())
17    }
18}