aws_sdk_snowdevicemanagement/client/list_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 [`ListExecutions`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`task_id(impl Into<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::task_id) / [`set_task_id(Option<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::set_task_id):<br>required: **true**<br><p>The ID of the task.</p><br>
8 /// - [`state(ExecutionState)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::state) / [`set_state(Option<ExecutionState>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::set_state):<br>required: **false**<br><p>A structure used to filter the tasks by their current state.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of tasks to list per page.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::set_next_token):<br>required: **false**<br><p>A pagination token to continue to the next page of tasks.</p><br>
11 /// - On success, responds with [`ListExecutionsOutput`](crate::operation::list_executions::ListExecutionsOutput) with field(s):
12 /// - [`executions(Option<Vec::<ExecutionSummary>>)`](crate::operation::list_executions::ListExecutionsOutput::executions): <p>A list of executions. Each execution contains the task ID, the device that the task is executing on, the execution ID, and the status of the execution.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::list_executions::ListExecutionsOutput::next_token): <p>A pagination token to continue to the next page of executions.</p>
14 /// - On failure, responds with [`SdkError<ListExecutionsError>`](crate::operation::list_executions::ListExecutionsError)
15 pub fn list_executions(&self) -> crate::operation::list_executions::builders::ListExecutionsFluentBuilder {
16 crate::operation::list_executions::builders::ListExecutionsFluentBuilder::new(self.handle.clone())
17 }
18}