Struct aws_sdk_transfer::operation::list_executions::builders::ListExecutionsFluentBuilder

pub struct ListExecutionsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ListExecutions.

Lists all in-progress executions for the specified workflow.

If the specified workflow ID cannot be found, ListExecutions returns a ResourceNotFound exception.

Implementations

impl ListExecutionsFluentBuilder

pub fn as_input(&self) -> &ListExecutionsInputBuilder

Access the ListExecutions as a reference.

pub async fn send( self, ) -> Result<ListExecutionsOutput, SdkError<ListExecutionsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<ListExecutionsOutput, ListExecutionsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> ListExecutionsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a PaginationStream.

pub fn max_results(self, input: i32) -> Self

Specifies the maximum number of executions to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

Specifies the maximum number of executions to return.

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

Specifies the maximum number of executions to return.

pub fn next_token(self, input: impl Into<String>) -> Self

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, call the API by specifying 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, supplying 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 set_next_token(self, input: Option<String>) -> Self

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, call the API by specifying 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, supplying 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 get_next_token(&self) -> &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, call the API by specifying 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, supplying 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, input: impl Into<String>) -> Self

A unique identifier for the workflow.

pub fn set_workflow_id(self, input: Option<String>) -> Self

A unique identifier for the workflow.

pub fn get_workflow_id(&self) -> &Option<String>

A unique identifier for the workflow.

Trait Implementations

impl Clone for ListExecutionsFluentBuilder

fn clone(&self) -> ListExecutionsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListExecutionsFluentBuilder

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

Formats the value using the given formatter.