Network.AWS.SWF.CountOpenWorkflowExecutions

Returns the number of open 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 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 .

Creating a Request

countOpenWorkflowExecutions

Arguments

:: Text

coweDomain

-> ExecutionTimeFilter

coweStartTimeFilter

-> CountOpenWorkflowExecutions

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

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

• coweExecutionFilter - If specified, only workflow executions matching the WorkflowId in the filter are counted.
• coweTypeFilter - Specifies the type of the workflow executions to be counted.
• coweTagFilter - If specified, only executions that have a tag that matches the filter are counted.
• coweDomain - The name of the domain containing the workflow executions to count.
• coweStartTimeFilter - Specifies the start time criteria that workflow executions must meet in order to be counted.

data CountOpenWorkflowExecutions

See: countOpenWorkflowExecutions smart constructor.

Instances

Eq CountOpenWorkflowExecutions

Methods

(==) :: CountOpenWorkflowExecutions -> CountOpenWorkflowExecutions -> Bool

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

Data CountOpenWorkflowExecutions

Methods

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

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

toConstr :: CountOpenWorkflowExecutions -> Constr

dataTypeOf :: CountOpenWorkflowExecutions -> DataType

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

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

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

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

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

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

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

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

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

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

Read CountOpenWorkflowExecutions

Methods

readsPrec :: Int -> ReadS CountOpenWorkflowExecutions

readList :: ReadS [CountOpenWorkflowExecutions]

readPrec :: ReadPrec CountOpenWorkflowExecutions

readListPrec :: ReadPrec [CountOpenWorkflowExecutions]

Show CountOpenWorkflowExecutions

Methods

showsPrec :: Int -> CountOpenWorkflowExecutions -> ShowS

show :: CountOpenWorkflowExecutions -> String

showList :: [CountOpenWorkflowExecutions] -> ShowS

Generic CountOpenWorkflowExecutions

Associated Types

type Rep CountOpenWorkflowExecutions :: * -> *

Methods

from :: CountOpenWorkflowExecutions -> Rep CountOpenWorkflowExecutions x

to :: Rep CountOpenWorkflowExecutions x -> CountOpenWorkflowExecutions

Hashable CountOpenWorkflowExecutions

Methods

hashWithSalt :: Int -> CountOpenWorkflowExecutions -> Int

hash :: CountOpenWorkflowExecutions -> Int

ToJSON CountOpenWorkflowExecutions

Methods

toJSON :: CountOpenWorkflowExecutions -> Value

toEncoding :: CountOpenWorkflowExecutions -> Encoding

toJSONList :: [CountOpenWorkflowExecutions] -> Value

toEncodingList :: [CountOpenWorkflowExecutions] -> Encoding

NFData CountOpenWorkflowExecutions

Methods

rnf :: CountOpenWorkflowExecutions -> ()

AWSRequest CountOpenWorkflowExecutions

Associated Types

type Rs CountOpenWorkflowExecutions :: *

Methods

request :: CountOpenWorkflowExecutions -> Request CountOpenWorkflowExecutions

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

ToQuery CountOpenWorkflowExecutions

Methods

toQuery :: CountOpenWorkflowExecutions -> QueryString

ToPath CountOpenWorkflowExecutions

Methods

toPath :: CountOpenWorkflowExecutions -> ByteString

ToHeaders CountOpenWorkflowExecutions

Methods

toHeaders :: CountOpenWorkflowExecutions -> [Header]

type Rep CountOpenWorkflowExecutions

type Rep CountOpenWorkflowExecutions = D1 (MetaData "CountOpenWorkflowExecutions" "Network.AWS.SWF.CountOpenWorkflowExecutions" "amazonka-swf-1.5.0-Iq58jBNwXOICscXZ8Q27Im" False) (C1 (MetaCons "CountOpenWorkflowExecutions'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_coweExecutionFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowExecutionFilter))) (S1 (MetaSel (Just Symbol "_coweTypeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe WorkflowTypeFilter)))) ((:*:) (S1 (MetaSel (Just Symbol "_coweTagFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TagFilter))) ((:*:) (S1 (MetaSel (Just Symbol "_coweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_coweStartTimeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ExecutionTimeFilter))))))

type Rs CountOpenWorkflowExecutions

type Rs CountOpenWorkflowExecutions = WorkflowExecutionCount

Request Lenses

coweExecutionFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowExecutionFilter)

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

coweTypeFilter :: Lens' CountOpenWorkflowExecutions (Maybe WorkflowTypeFilter)

Specifies the type of the workflow executions to be counted.

coweTagFilter :: Lens' CountOpenWorkflowExecutions (Maybe TagFilter)

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

coweDomain :: Lens' CountOpenWorkflowExecutions Text

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

coweStartTimeFilter :: Lens' CountOpenWorkflowExecutions ExecutionTimeFilter

Specifies the start time criteria that workflow executions must meet in order to be counted.

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.5.0-Iq58jBNwXOICscXZ8Q27Im" 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.