Network.AWS.SWF.ListClosedWorkflowExecutions

Returns a list of closed 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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

This operation returns paginated results.

Creating a Request

listClosedWorkflowExecutions

Arguments

:: Text

lcweDomain

-> ListClosedWorkflowExecutions

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

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

• lcweNextPageToken
• lcweExecutionFilter
• lcweCloseStatusFilter
• lcweTypeFilter
• lcweCloseTimeFilter
• lcweReverseOrder
• lcweTagFilter
• lcweStartTimeFilter
• lcweMaximumPageSize
• lcweDomain

data ListClosedWorkflowExecutions

See: listClosedWorkflowExecutions smart constructor.

Instances

Eq ListClosedWorkflowExecutions

Methods

(==) :: ListClosedWorkflowExecutions -> ListClosedWorkflowExecutions -> Bool

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

Data ListClosedWorkflowExecutions

Methods

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

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

toConstr :: ListClosedWorkflowExecutions -> Constr

dataTypeOf :: ListClosedWorkflowExecutions -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListClosedWorkflowExecutions

Methods

readsPrec :: Int -> ReadS ListClosedWorkflowExecutions

readList :: ReadS [ListClosedWorkflowExecutions]

readPrec :: ReadPrec ListClosedWorkflowExecutions

readListPrec :: ReadPrec [ListClosedWorkflowExecutions]

Show ListClosedWorkflowExecutions

Methods

showsPrec :: Int -> ListClosedWorkflowExecutions -> ShowS

show :: ListClosedWorkflowExecutions -> String

showList :: [ListClosedWorkflowExecutions] -> ShowS

Generic ListClosedWorkflowExecutions

Associated Types

type Rep ListClosedWorkflowExecutions :: * -> *

Methods

from :: ListClosedWorkflowExecutions -> Rep ListClosedWorkflowExecutions x

to :: Rep ListClosedWorkflowExecutions x -> ListClosedWorkflowExecutions

Hashable ListClosedWorkflowExecutions

Methods

hashWithSalt :: Int -> ListClosedWorkflowExecutions -> Int

hash :: ListClosedWorkflowExecutions -> Int

NFData ListClosedWorkflowExecutions

Methods

rnf :: ListClosedWorkflowExecutions -> ()

AWSPager ListClosedWorkflowExecutions

Methods

page :: ListClosedWorkflowExecutions -> Rs ListClosedWorkflowExecutions -> Maybe ListClosedWorkflowExecutions

AWSRequest ListClosedWorkflowExecutions

Associated Types

type Rs ListClosedWorkflowExecutions :: *

Methods

request :: ListClosedWorkflowExecutions -> Request ListClosedWorkflowExecutions

response :: MonadResource m => Logger -> Service -> Proxy * ListClosedWorkflowExecutions -> ClientResponse -> m (Response ListClosedWorkflowExecutions)

ToPath ListClosedWorkflowExecutions

Methods

toPath :: ListClosedWorkflowExecutions -> ByteString

ToHeaders ListClosedWorkflowExecutions

Methods

toHeaders :: ListClosedWorkflowExecutions -> [Header]

ToQuery ListClosedWorkflowExecutions

Methods

toQuery :: ListClosedWorkflowExecutions -> QueryString

ToJSON ListClosedWorkflowExecutions

Methods

toJSON :: ListClosedWorkflowExecutions -> Value

toEncoding :: ListClosedWorkflowExecutions -> Encoding

type Rep ListClosedWorkflowExecutions

type Rep ListClosedWorkflowExecutions = D1 (MetaData "ListClosedWorkflowExecutions" "Network.AWS.SWF.ListClosedWorkflowExecutions" "amazonka-swf-1.4.4-Dp39L54BbNUBjEhUE6RLW2" False) (C1 (MetaCons "ListClosedWorkflowExecutions'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lcweNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_lcweExecutionFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter)))) ((:*:) (S1 (MetaSel (Just Symbol "_lcweCloseStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CloseStatusFilter))) ((:*:) (S1 (MetaSel (Just Symbol "_lcweTypeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter))) (S1 (MetaSel (Just Symbol "_lcweCloseTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_lcweReverseOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_lcweTagFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TagFilter)))) ((:*:) (S1 (MetaSel (Just Symbol "_lcweStartTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter))) ((:*:) (S1 (MetaSel (Just Symbol "_lcweMaximumPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lcweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs ListClosedWorkflowExecutions

type Rs ListClosedWorkflowExecutions = WorkflowExecutionInfos

Request Lenses

lcweNextPageToken :: Lens' ListClosedWorkflowExecutions (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.

lcweExecutionFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweCloseStatusFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweTypeFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweCloseTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweReverseOrder :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweTagFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweStartTimeFilter :: Lens' ListClosedWorkflowExecutions (Maybe 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.

lcweMaximumPageSize :: Lens' ListClosedWorkflowExecutions (Maybe Natural)

The maximum number of results that will be 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.

lcweDomain :: Lens' ListClosedWorkflowExecutions Text

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

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
• weiExecutionInfos

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

NFData WorkflowExecutionInfos

Methods

rnf :: WorkflowExecutionInfos -> ()

FromJSON WorkflowExecutionInfos

Methods

parseJSON :: Value -> Parser WorkflowExecutionInfos

type Rep WorkflowExecutionInfos

type Rep WorkflowExecutionInfos = D1 (MetaData "WorkflowExecutionInfos" "Network.AWS.SWF.Types.Product" "amazonka-swf-1.4.4-Dp39L54BbNUBjEhUE6RLW2" 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.