Struct aws_sdk_swf::client::fluent_builders::ListOpenWorkflowExecutions

pub struct ListOpenWorkflowExecutions { /* private fields */ }

Fluent builder constructing a request to ListOpenWorkflowExecutions.

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.

• Use an Action element to allow or deny permission to call this action.

• Constrain the following parameters by using a Condition element with the appropriate keys.

  • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

  • typeFilter.name: String constraint. The key is swf:typeFilter.name.

  • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

Implementations

impl ListOpenWorkflowExecutions

pub async fn customize(
    self
) -> Result<CustomizableOperation<ListOpenWorkflowExecutions, AwsResponseRetryClassifier>, SdkError<ListOpenWorkflowExecutionsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ListOpenWorkflowExecutionsOutput, SdkError<ListOpenWorkflowExecutionsError>>

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 into_paginator(self) -> ListOpenWorkflowExecutionsPaginator

Create a paginator for this request

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

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

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

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

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

pub fn start_time_filter(self, input: ExecutionTimeFilter) -> Self

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

pub fn set_start_time_filter(self, input: Option<ExecutionTimeFilter>) -> Self

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

pub fn type_filter(self, input: WorkflowTypeFilter) -> Self

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

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

pub fn set_type_filter(self, input: Option<WorkflowTypeFilter>) -> Self

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

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

pub fn tag_filter(self, input: TagFilter) -> Self

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

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

pub fn set_tag_filter(self, input: Option<TagFilter>) -> Self

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

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

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

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 set_next_page_token(self, input: Option<String>) -> Self

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, input: i32) -> Self

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

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

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

pub fn reverse_order(self, input: bool) -> Self

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

pub fn set_reverse_order(self, input: Option<bool>) -> Self

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

pub fn execution_filter(self, input: WorkflowExecutionFilter) -> Self

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

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

pub fn set_execution_filter(self, input: Option<WorkflowExecutionFilter>) -> Self

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

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

Trait Implementations

impl Clone for ListOpenWorkflowExecutions

fn clone(&self) -> ListOpenWorkflowExecutions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListOpenWorkflowExecutions

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

Formats the value using the given formatter.