amazonka-swf-1.6.1: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.CountPendingActivityTasks

Contents

Description

Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

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 taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

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 .

Synopsis

Creating a Request

countPendingActivityTasks Source #

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

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

data CountPendingActivityTasks Source #

See: countPendingActivityTasks smart constructor.

Instances
Eq CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Data CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Methods

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

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

toConstr :: CountPendingActivityTasks -> Constr #

dataTypeOf :: CountPendingActivityTasks -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CountPendingActivityTasks) #

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

gmapT :: (forall b. Data b => b -> b) -> CountPendingActivityTasks -> CountPendingActivityTasks #

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

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

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

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

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

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

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

Read CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Show CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Generic CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Associated Types

type Rep CountPendingActivityTasks :: Type -> Type #

Hashable CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

ToJSON CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

AWSRequest CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Associated Types

type Rs CountPendingActivityTasks :: Type #

ToHeaders CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

ToPath CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

ToQuery CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

NFData CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

type Rep CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

type Rep CountPendingActivityTasks = D1 (MetaData "CountPendingActivityTasks" "Network.AWS.SWF.CountPendingActivityTasks" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "CountPendingActivityTasks'" PrefixI True) (S1 (MetaSel (Just "_cpatDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cpatTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TaskList)))
type Rs CountPendingActivityTasks Source # 
Instance details

Defined in Network.AWS.SWF.CountPendingActivityTasks

Request Lenses

cpatDomain :: Lens' CountPendingActivityTasks Text Source #

The name of the domain that contains the task list.

Destructuring the Response

pendingTaskCount Source #

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

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

  • ptcTruncated - 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.
  • ptcCount - The number of tasks in the task list.

data PendingTaskCount Source #

Contains the count of tasks in a task list.

See: pendingTaskCount smart constructor.

Instances
Eq PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Data PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Methods

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

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

toConstr :: PendingTaskCount -> Constr #

dataTypeOf :: PendingTaskCount -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PendingTaskCount) #

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

gmapT :: (forall b. Data b => b -> b) -> PendingTaskCount -> PendingTaskCount #

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

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

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

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

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

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

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

Read PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Show PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Generic PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Associated Types

type Rep PendingTaskCount :: Type -> Type #

Hashable PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

FromJSON PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

NFData PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

Methods

rnf :: PendingTaskCount -> () #

type Rep PendingTaskCount Source # 
Instance details

Defined in Network.AWS.SWF.Types.Product

type Rep PendingTaskCount = D1 (MetaData "PendingTaskCount" "Network.AWS.SWF.Types.Product" "amazonka-swf-1.6.1-3kde1KSCGTp3D4Dj0lEH55" False) (C1 (MetaCons "PendingTaskCount'" PrefixI True) (S1 (MetaSel (Just "_ptcTruncated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_ptcCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)))

Response Lenses

ptcTruncated :: Lens' PendingTaskCount (Maybe Bool) Source #

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.

ptcCount :: Lens' PendingTaskCount Natural Source #

The number of tasks in the task list.