aws_sdk_transfer/client/
list_executions.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListExecutions`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`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>Specifies the maximum number of executions to return.</p><br>
    ///   - [`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><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p> <p>This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to list first 10. If so, call the API by specifying the <code>max-results</code>:</p> <p><code>aws transfer list-executions --max-results 10</code></p> <p>This returns details for the first 10 executions, as well as the pointer (<code>NextToken</code>) to the eleventh execution. You can now call the API again, supplying the <code>NextToken</code> value you received:</p> <p><code>aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult</code></p> <p>This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.</p><br>
    ///   - [`workflow_id(impl Into<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::workflow_id) / [`set_workflow_id(Option<String>)`](crate::operation::list_executions::builders::ListExecutionsFluentBuilder::set_workflow_id):<br>required: **true**<br><p>A unique identifier for the workflow.</p><br>
    /// - On success, responds with [`ListExecutionsOutput`](crate::operation::list_executions::ListExecutionsOutput) with field(s):
    ///   - [`next_token(Option<String>)`](crate::operation::list_executions::ListExecutionsOutput::next_token): <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    ///   - [`workflow_id(String)`](crate::operation::list_executions::ListExecutionsOutput::workflow_id): <p>A unique identifier for the workflow.</p>
    ///   - [`executions(Vec::<ListedExecution>)`](crate::operation::list_executions::ListExecutionsOutput::executions): <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    /// - On failure, responds with [`SdkError<ListExecutionsError>`](crate::operation::list_executions::ListExecutionsError)
    pub fn list_executions(&self) -> crate::operation::list_executions::builders::ListExecutionsFluentBuilder {
        crate::operation::list_executions::builders::ListExecutionsFluentBuilder::new(self.handle.clone())
    }
}