Copyright	(c) 2013-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SWF.CountClosedWorkflowExecutions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

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 .

Synopsis

Creating a Request

countClosedWorkflowExecutions #

Arguments

:: Text	`ccweDomain`
-> CountClosedWorkflowExecutions

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

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

ccweExecutionFilter - If specified, only workflow executions matching the WorkflowId in the filter are counted.
ccweCloseStatusFilter - If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED .
ccweTypeFilter - If specified, indicates the type of the workflow executions to be counted.
ccweCloseTimeFilter - If specified, only workflow executions that meet the close time criteria of the filter are counted.
ccweTagFilter - If specified, only executions that have a tag that matches the filter are counted.
ccweStartTimeFilter - If specified, only workflow executions that meet the start time criteria of the filter are counted.
ccweDomain - The name of the domain containing the workflow executions to count.

data CountClosedWorkflowExecutions #

See: countClosedWorkflowExecutions smart constructor.

Instances

Eq CountClosedWorkflowExecutions #
Methods (==) :: CountClosedWorkflowExecutions -> CountClosedWorkflowExecutions -> Bool # (/=) :: CountClosedWorkflowExecutions -> CountClosedWorkflowExecutions -> Bool #
Data CountClosedWorkflowExecutions #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CountClosedWorkflowExecutions -> c CountClosedWorkflowExecutions # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CountClosedWorkflowExecutions # toConstr :: CountClosedWorkflowExecutions -> Constr # dataTypeOf :: CountClosedWorkflowExecutions -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CountClosedWorkflowExecutions) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CountClosedWorkflowExecutions) # gmapT :: (forall b. Data b => b -> b) -> CountClosedWorkflowExecutions -> CountClosedWorkflowExecutions # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CountClosedWorkflowExecutions -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CountClosedWorkflowExecutions -> r # gmapQ :: (forall d. Data d => d -> u) -> CountClosedWorkflowExecutions -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CountClosedWorkflowExecutions -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CountClosedWorkflowExecutions -> m CountClosedWorkflowExecutions # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CountClosedWorkflowExecutions -> m CountClosedWorkflowExecutions # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CountClosedWorkflowExecutions -> m CountClosedWorkflowExecutions #
Read CountClosedWorkflowExecutions #
Methods readsPrec :: Int -> ReadS CountClosedWorkflowExecutions # readList :: ReadS [CountClosedWorkflowExecutions] # readPrec :: ReadPrec CountClosedWorkflowExecutions # readListPrec :: ReadPrec [CountClosedWorkflowExecutions] #
Show CountClosedWorkflowExecutions #
Methods showsPrec :: Int -> CountClosedWorkflowExecutions -> ShowS # show :: CountClosedWorkflowExecutions -> String # showList :: [CountClosedWorkflowExecutions] -> ShowS #
Generic CountClosedWorkflowExecutions #
Associated Types type Rep CountClosedWorkflowExecutions :: * -> * # Methods from :: CountClosedWorkflowExecutions -> Rep CountClosedWorkflowExecutions x # to :: Rep CountClosedWorkflowExecutions x -> CountClosedWorkflowExecutions #
Hashable CountClosedWorkflowExecutions #
Methods hashWithSalt :: Int -> CountClosedWorkflowExecutions -> Int # hash :: CountClosedWorkflowExecutions -> Int #
ToJSON CountClosedWorkflowExecutions #
Methods toJSON :: CountClosedWorkflowExecutions -> Value # toEncoding :: CountClosedWorkflowExecutions -> Encoding # toJSONList :: [CountClosedWorkflowExecutions] -> Value # toEncodingList :: [CountClosedWorkflowExecutions] -> Encoding #
NFData CountClosedWorkflowExecutions #
Methods rnf :: CountClosedWorkflowExecutions -> () #
AWSRequest CountClosedWorkflowExecutions #
Associated Types type Rs CountClosedWorkflowExecutions :: * # Methods request :: CountClosedWorkflowExecutions -> Request CountClosedWorkflowExecutions # response :: MonadResource m => Logger -> Service -> Proxy * CountClosedWorkflowExecutions -> ClientResponse -> m (Response CountClosedWorkflowExecutions) #
ToQuery CountClosedWorkflowExecutions #
Methods toQuery :: CountClosedWorkflowExecutions -> QueryString #
ToPath CountClosedWorkflowExecutions #
Methods toPath :: CountClosedWorkflowExecutions -> ByteString #
ToHeaders CountClosedWorkflowExecutions #
Methods toHeaders :: CountClosedWorkflowExecutions -> [Header] #
type Rep CountClosedWorkflowExecutions #
type Rep CountClosedWorkflowExecutions = D1 (MetaData "CountClosedWorkflowExecutions" "Network.AWS.SWF.CountClosedWorkflowExecutions" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "CountClosedWorkflowExecutions'" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "_ccweExecutionFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter))) ((::) (S1 (MetaSel (Just Symbol "_ccweCloseStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CloseStatusFilter))) (S1 (MetaSel (Just Symbol "_ccweTypeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter))))) ((::) ((::) (S1 (MetaSel (Just Symbol "_ccweCloseTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter))) (S1 (MetaSel (Just Symbol "_ccweTagFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TagFilter)))) ((::) (S1 (MetaSel (Just Symbol "_ccweStartTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ExecutionTimeFilter))) (S1 (MetaSel (Just Symbol "_ccweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CountClosedWorkflowExecutions #
type Rs CountClosedWorkflowExecutions = WorkflowExecutionCount

Request Lenses

ccweExecutionFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowExecutionFilter) #

If specified, only workflow executions matching the WorkflowId in the filter are counted.

ccweCloseStatusFilter :: Lens' CountClosedWorkflowExecutions (Maybe CloseStatusFilter) #

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED .

ccweTypeFilter :: Lens' CountClosedWorkflowExecutions (Maybe WorkflowTypeFilter) #

If specified, indicates the type of the workflow executions to be counted.

ccweCloseTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) #

If specified, only workflow executions that meet the close time criteria of the filter are counted.

ccweTagFilter :: Lens' CountClosedWorkflowExecutions (Maybe TagFilter) #

If specified, only executions that have a tag that matches the filter are counted.

ccweStartTimeFilter :: Lens' CountClosedWorkflowExecutions (Maybe ExecutionTimeFilter) #

If specified, only workflow executions that meet the start time criteria of the filter are counted.

ccweDomain :: Lens' CountClosedWorkflowExecutions Text #

The name of the domain containing the workflow executions to count.

Destructuring the Response

workflowExecutionCount #

Arguments

:: Natural	`wecCount`
-> WorkflowExecutionCount

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

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

wecTruncated - If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
wecCount - The number of workflow executions.

data WorkflowExecutionCount #

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

See: workflowExecutionCount smart constructor.

Instances

Eq WorkflowExecutionCount #
Methods (==) :: WorkflowExecutionCount -> WorkflowExecutionCount -> Bool # (/=) :: WorkflowExecutionCount -> WorkflowExecutionCount -> Bool #
Data WorkflowExecutionCount #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> WorkflowExecutionCount -> c WorkflowExecutionCount # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c WorkflowExecutionCount # toConstr :: WorkflowExecutionCount -> Constr # dataTypeOf :: WorkflowExecutionCount -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c WorkflowExecutionCount) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c WorkflowExecutionCount) # gmapT :: (forall b. Data b => b -> b) -> WorkflowExecutionCount -> WorkflowExecutionCount # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> WorkflowExecutionCount -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> WorkflowExecutionCount -> r # gmapQ :: (forall d. Data d => d -> u) -> WorkflowExecutionCount -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> WorkflowExecutionCount -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> WorkflowExecutionCount -> m WorkflowExecutionCount # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> WorkflowExecutionCount -> m WorkflowExecutionCount # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> WorkflowExecutionCount -> m WorkflowExecutionCount #
Read WorkflowExecutionCount #
Methods readsPrec :: Int -> ReadS WorkflowExecutionCount # readList :: ReadS [WorkflowExecutionCount] # readPrec :: ReadPrec WorkflowExecutionCount # readListPrec :: ReadPrec [WorkflowExecutionCount] #
Show WorkflowExecutionCount #
Methods showsPrec :: Int -> WorkflowExecutionCount -> ShowS # show :: WorkflowExecutionCount -> String # showList :: [WorkflowExecutionCount] -> ShowS #
Generic WorkflowExecutionCount #
Associated Types type Rep WorkflowExecutionCount :: * -> * # Methods from :: WorkflowExecutionCount -> Rep WorkflowExecutionCount x # to :: Rep WorkflowExecutionCount x -> WorkflowExecutionCount #
Hashable WorkflowExecutionCount #
Methods hashWithSalt :: Int -> WorkflowExecutionCount -> Int # hash :: WorkflowExecutionCount -> Int #
FromJSON WorkflowExecutionCount #
Methods parseJSON :: Value -> Parser WorkflowExecutionCount # parseJSONList :: Value -> Parser [WorkflowExecutionCount] #
NFData WorkflowExecutionCount #
Methods rnf :: WorkflowExecutionCount -> () #
type Rep WorkflowExecutionCount #
type Rep WorkflowExecutionCount = D1 (MetaData "WorkflowExecutionCount" "Network.AWS.SWF.Types.Product" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "WorkflowExecutionCount'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_wecTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_wecCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

Response Lenses

wecTruncated :: Lens' WorkflowExecutionCount (Maybe Bool) #

If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

wecCount :: Lens' WorkflowExecutionCount Natural #

The number of workflow executions.