Struct aws_sdk_transfer::input::ListExecutionsInput

#[non_exhaustive]
pub struct ListExecutionsInput {
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub workflow_id: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_results: Option<i32>

Specifies the aximum number of executions to return.

next_token: Option<String>

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

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, callthe API by specifing the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

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.

workflow_id: Option<String>

A unique identifier for the workflow.

Implementations

impl ListExecutionsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListExecutions, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListExecutions>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListExecutionsInput

impl ListExecutionsInput

pub fn max_results(&self) -> Option<i32>

Specifies the aximum number of executions to return.

pub fn next_token(&self) -> Option<&str>

ListExecutions returns the NextToken parameter in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional executions.

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, callthe API by specifing the max-results:

aws transfer list-executions --max-results 10

This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh execution. You can now call the API again, suppling the NextToken value you received:

aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult

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.

pub fn workflow_id(&self) -> Option<&str>

A unique identifier for the workflow.

Trait Implementations

impl Clone for ListExecutionsInput

fn clone(&self) -> ListExecutionsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListExecutionsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ListExecutionsInput> for ListExecutionsInput

fn eq(&self, other: &ListExecutionsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListExecutionsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ListExecutionsInput