Network.AWS.SWF.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.

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 .

This operation returns paginated results.

Creating a Request

listOpenWorkflowExecutions

Arguments

:: Text

loweDomain

-> ExecutionTimeFilter

loweStartTimeFilter

-> ListOpenWorkflowExecutions

Creates a value of ListOpenWorkflowExecutions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• loweNextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken . Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
• loweExecutionFilter - If specified, only workflow executions matching the workflow ID specified in the filter are returned.
• loweTypeFilter - If specified, only executions of the type specified in the filter are returned.
• loweReverseOrder - 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.
• loweTagFilter - If specified, only executions that have the matching tag are listed.
• loweMaximumPageSize - The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
• loweDomain - The name of the domain that contains the workflow executions to list.
• loweStartTimeFilter - Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

data ListOpenWorkflowExecutions

See: listOpenWorkflowExecutions smart constructor.

Instances

Eq ListOpenWorkflowExecutions

Methods

(==) :: ListOpenWorkflowExecutions -> ListOpenWorkflowExecutions -> Bool

(/=) :: ListOpenWorkflowExecutions -> ListOpenWorkflowExecutions -> Bool

Data ListOpenWorkflowExecutions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListOpenWorkflowExecutions -> c ListOpenWorkflowExecutions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListOpenWorkflowExecutions

toConstr :: ListOpenWorkflowExecutions -> Constr

dataTypeOf :: ListOpenWorkflowExecutions -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListOpenWorkflowExecutions)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListOpenWorkflowExecutions)

gmapT :: (forall b. Data b => b -> b) -> ListOpenWorkflowExecutions -> ListOpenWorkflowExecutions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListOpenWorkflowExecutions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListOpenWorkflowExecutions -> r

gmapQ :: (forall d. Data d => d -> u) -> ListOpenWorkflowExecutions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListOpenWorkflowExecutions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListOpenWorkflowExecutions -> m ListOpenWorkflowExecutions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOpenWorkflowExecutions -> m ListOpenWorkflowExecutions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListOpenWorkflowExecutions -> m ListOpenWorkflowExecutions

Read ListOpenWorkflowExecutions

Methods

readsPrec :: Int -> ReadS ListOpenWorkflowExecutions

readList :: ReadS [ListOpenWorkflowExecutions]

readPrec :: ReadPrec ListOpenWorkflowExecutions

readListPrec :: ReadPrec [ListOpenWorkflowExecutions]

Show ListOpenWorkflowExecutions

Methods

showsPrec :: Int -> ListOpenWorkflowExecutions -> ShowS

show :: ListOpenWorkflowExecutions -> String

showList :: [ListOpenWorkflowExecutions] -> ShowS

Generic ListOpenWorkflowExecutions

Associated Types

type Rep ListOpenWorkflowExecutions :: * -> *

Methods

from :: ListOpenWorkflowExecutions -> Rep ListOpenWorkflowExecutions x

to :: Rep ListOpenWorkflowExecutions x -> ListOpenWorkflowExecutions

Hashable ListOpenWorkflowExecutions

Methods

hashWithSalt :: Int -> ListOpenWorkflowExecutions -> Int

hash :: ListOpenWorkflowExecutions -> Int

ToJSON ListOpenWorkflowExecutions

Methods

toJSON :: ListOpenWorkflowExecutions -> Value

toEncoding :: ListOpenWorkflowExecutions -> Encoding

toJSONList :: [ListOpenWorkflowExecutions] -> Value

toEncodingList :: [ListOpenWorkflowExecutions] -> Encoding

NFData ListOpenWorkflowExecutions

Methods

rnf :: ListOpenWorkflowExecutions -> ()

AWSPager ListOpenWorkflowExecutions

Methods

page :: ListOpenWorkflowExecutions -> Rs ListOpenWorkflowExecutions -> Maybe ListOpenWorkflowExecutions

AWSRequest ListOpenWorkflowExecutions

Associated Types

type Rs ListOpenWorkflowExecutions :: *

Methods

request :: ListOpenWorkflowExecutions -> Request ListOpenWorkflowExecutions

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListOpenWorkflowExecutions -> ClientResponse -> m (Response ListOpenWorkflowExecutions)

ToHeaders ListOpenWorkflowExecutions

Methods

toHeaders :: ListOpenWorkflowExecutions -> [Header]

ToPath ListOpenWorkflowExecutions

Methods

toPath :: ListOpenWorkflowExecutions -> ByteString

ToQuery ListOpenWorkflowExecutions

Methods

toQuery :: ListOpenWorkflowExecutions -> QueryString

type Rep ListOpenWorkflowExecutions

type Rep ListOpenWorkflowExecutions = D1 * (MetaData "ListOpenWorkflowExecutions" "Network.AWS.SWF.ListOpenWorkflowExecutions" "amazonka-swf-1.6.0-Bzu8JdnZDC6G5pdcX5JdA8" False) (C1 * (MetaCons "ListOpenWorkflowExecutions'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_loweNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_loweExecutionFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe WorkflowExecutionFilter)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_loweTypeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe WorkflowTypeFilter))) (S1 * (MetaSel (Just Symbol "_loweReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_loweTagFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe TagFilter))) (S1 * (MetaSel (Just Symbol "_loweMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_loweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_loweStartTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ExecutionTimeFilter))))))

type Rs ListOpenWorkflowExecutions

type Rs ListOpenWorkflowExecutions = WorkflowExecutionInfos

Request Lenses

loweNextPageToken :: Lens' ListOpenWorkflowExecutions (Maybe Text)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken . Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.

loweExecutionFilter :: Lens' ListOpenWorkflowExecutions (Maybe WorkflowExecutionFilter)

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

loweTypeFilter :: Lens' ListOpenWorkflowExecutions (Maybe WorkflowTypeFilter)

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

loweReverseOrder :: Lens' ListOpenWorkflowExecutions (Maybe Bool)

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.

loweTagFilter :: Lens' ListOpenWorkflowExecutions (Maybe TagFilter)

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

loweMaximumPageSize :: Lens' ListOpenWorkflowExecutions (Maybe Natural)

The maximum number of results that are returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum. This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

loweDomain :: Lens' ListOpenWorkflowExecutions Text

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

loweStartTimeFilter :: Lens' ListOpenWorkflowExecutions ExecutionTimeFilter

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

Destructuring the Response

workflowExecutionInfos :: WorkflowExecutionInfos

Creates a value of WorkflowExecutionInfos with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• weiNextPageToken - If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken . Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.
• weiExecutionInfos - The list of workflow information structures.

data WorkflowExecutionInfos

Contains a paginated list of information about workflow executions.

See: workflowExecutionInfos smart constructor.

Instances

Eq WorkflowExecutionInfos

Methods

(==) :: WorkflowExecutionInfos -> WorkflowExecutionInfos -> Bool

(/=) :: WorkflowExecutionInfos -> WorkflowExecutionInfos -> Bool

Data WorkflowExecutionInfos

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WorkflowExecutionInfos -> c WorkflowExecutionInfos

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WorkflowExecutionInfos

toConstr :: WorkflowExecutionInfos -> Constr

dataTypeOf :: WorkflowExecutionInfos -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c WorkflowExecutionInfos)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WorkflowExecutionInfos)

gmapT :: (forall b. Data b => b -> b) -> WorkflowExecutionInfos -> WorkflowExecutionInfos

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WorkflowExecutionInfos -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WorkflowExecutionInfos -> r

gmapQ :: (forall d. Data d => d -> u) -> WorkflowExecutionInfos -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> WorkflowExecutionInfos -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> WorkflowExecutionInfos -> m WorkflowExecutionInfos

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WorkflowExecutionInfos -> m WorkflowExecutionInfos

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WorkflowExecutionInfos -> m WorkflowExecutionInfos

Read WorkflowExecutionInfos

Methods

readsPrec :: Int -> ReadS WorkflowExecutionInfos

readList :: ReadS [WorkflowExecutionInfos]

readPrec :: ReadPrec WorkflowExecutionInfos

readListPrec :: ReadPrec [WorkflowExecutionInfos]

Show WorkflowExecutionInfos

Methods

showsPrec :: Int -> WorkflowExecutionInfos -> ShowS

show :: WorkflowExecutionInfos -> String

showList :: [WorkflowExecutionInfos] -> ShowS

Generic WorkflowExecutionInfos

Associated Types

type Rep WorkflowExecutionInfos :: * -> *

Methods

from :: WorkflowExecutionInfos -> Rep WorkflowExecutionInfos x

to :: Rep WorkflowExecutionInfos x -> WorkflowExecutionInfos

Hashable WorkflowExecutionInfos

Methods

hashWithSalt :: Int -> WorkflowExecutionInfos -> Int

hash :: WorkflowExecutionInfos -> Int

FromJSON WorkflowExecutionInfos

Methods

parseJSON :: Value -> Parser WorkflowExecutionInfos

parseJSONList :: Value -> Parser [WorkflowExecutionInfos]

NFData WorkflowExecutionInfos

Methods

rnf :: WorkflowExecutionInfos -> ()

type Rep WorkflowExecutionInfos

type Rep WorkflowExecutionInfos = D1 * (MetaData "WorkflowExecutionInfos" "Network.AWS.SWF.Types.Product" "amazonka-swf-1.6.0-Bzu8JdnZDC6G5pdcX5JdA8" False) (C1 * (MetaCons "WorkflowExecutionInfos'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_weiNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_weiExecutionInfos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [WorkflowExecutionInfo]))))

Response Lenses

weiNextPageToken :: Lens' WorkflowExecutionInfos (Maybe Text)

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken . Keep all other arguments unchanged. The configured maximumPageSize determines how many results can be returned in a single call.

weiExecutionInfos :: Lens' WorkflowExecutionInfos [WorkflowExecutionInfo]

The list of workflow information structures.