Struct aws_sdk_swf::input::ListClosedWorkflowExecutionsInput

#[non_exhaustive]
pub struct ListClosedWorkflowExecutionsInput {
    pub domain: Option<String>,
    pub start_time_filter: Option<ExecutionTimeFilter>,
    pub close_time_filter: Option<ExecutionTimeFilter>,
    pub execution_filter: Option<WorkflowExecutionFilter>,
    pub close_status_filter: Option<CloseStatusFilter>,
    pub type_filter: Option<WorkflowTypeFilter>,
    pub tag_filter: Option<TagFilter>,
    pub next_page_token: Option<String>,
    pub maximum_page_size: i32,
    pub reverse_order: bool,
}

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.

domain: Option<String>

The name of the domain that contains the workflow executions to list.

start_time_filter: Option<ExecutionTimeFilter>

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

close_time_filter: Option<ExecutionTimeFilter>

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

execution_filter: Option<WorkflowExecutionFilter>

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

close_status_filter: Option<CloseStatusFilter>

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

type_filter: Option<WorkflowTypeFilter>

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

tag_filter: Option<TagFilter>

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

next_page_token: Option<String>

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

maximum_page_size: i32

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

reverse_order: bool

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Implementations

impl ListClosedWorkflowExecutionsInput

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

Consumes the builder and constructs an Operation<ListClosedWorkflowExecutions>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListClosedWorkflowExecutionsInput

impl ListClosedWorkflowExecutionsInput

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

The name of the domain that contains the workflow executions to list.

pub fn start_time_filter(&self) -> Option<&ExecutionTimeFilter>

If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

pub fn close_time_filter(&self) -> Option<&ExecutionTimeFilter>

If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

pub fn execution_filter(&self) -> Option<&WorkflowExecutionFilter>

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn close_status_filter(&self) -> Option<&CloseStatusFilter>

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn type_filter(&self) -> Option<&WorkflowTypeFilter>

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

pub fn tag_filter(&self) -> Option<&TagFilter>

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

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

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

pub fn maximum_page_size(&self) -> i32

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

pub fn reverse_order(&self) -> bool

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

Trait Implementations

impl Clone for ListClosedWorkflowExecutionsInput

fn clone(&self) -> ListClosedWorkflowExecutionsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListClosedWorkflowExecutionsInput

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

Formats the value using the given formatter.

impl PartialEq<ListClosedWorkflowExecutionsInput> for ListClosedWorkflowExecutionsInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for ListClosedWorkflowExecutionsInput