Network.AWS.SWF.CountPendingActivityTasks

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 .

Creating a Request

countPendingActivityTasks

Arguments

:: Text

cpatDomain

-> TaskList

cpatTaskList

-> CountPendingActivityTasks

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:

• cpatDomain - The name of the domain that contains the task list.
• cpatTaskList - The name of the task list.

data CountPendingActivityTasks

See: countPendingActivityTasks smart constructor.

Instances

Eq CountPendingActivityTasks

Methods

(==) :: CountPendingActivityTasks -> CountPendingActivityTasks -> Bool

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

Data 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

Methods

readsPrec :: Int -> ReadS CountPendingActivityTasks

readList :: ReadS [CountPendingActivityTasks]

readPrec :: ReadPrec CountPendingActivityTasks

readListPrec :: ReadPrec [CountPendingActivityTasks]

Show CountPendingActivityTasks

Methods

showsPrec :: Int -> CountPendingActivityTasks -> ShowS

show :: CountPendingActivityTasks -> String

showList :: [CountPendingActivityTasks] -> ShowS

Generic CountPendingActivityTasks

Associated Types

type Rep CountPendingActivityTasks :: * -> *

Methods

from :: CountPendingActivityTasks -> Rep CountPendingActivityTasks x

to :: Rep CountPendingActivityTasks x -> CountPendingActivityTasks

Hashable CountPendingActivityTasks

Methods

hashWithSalt :: Int -> CountPendingActivityTasks -> Int

hash :: CountPendingActivityTasks -> Int

ToJSON CountPendingActivityTasks

Methods

toJSON :: CountPendingActivityTasks -> Value

toEncoding :: CountPendingActivityTasks -> Encoding

toJSONList :: [CountPendingActivityTasks] -> Value

toEncodingList :: [CountPendingActivityTasks] -> Encoding

NFData CountPendingActivityTasks

Methods

rnf :: CountPendingActivityTasks -> ()

AWSRequest CountPendingActivityTasks

Associated Types

type Rs CountPendingActivityTasks :: *

Methods

request :: CountPendingActivityTasks -> Request CountPendingActivityTasks

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

ToHeaders CountPendingActivityTasks

Methods

toHeaders :: CountPendingActivityTasks -> [Header]

ToPath CountPendingActivityTasks

Methods

toPath :: CountPendingActivityTasks -> ByteString

ToQuery CountPendingActivityTasks

Methods

toQuery :: CountPendingActivityTasks -> QueryString

type Rep CountPendingActivityTasks

type Rep CountPendingActivityTasks = D1 * (MetaData "CountPendingActivityTasks" "Network.AWS.SWF.CountPendingActivityTasks" "amazonka-swf-1.6.0-Bzu8JdnZDC6G5pdcX5JdA8" False) (C1 * (MetaCons "CountPendingActivityTasks'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cpatDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cpatTaskList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TaskList))))

type Rs CountPendingActivityTasks

type Rs CountPendingActivityTasks = PendingTaskCount

Request Lenses

cpatDomain :: Lens' CountPendingActivityTasks Text

The name of the domain that contains the task list.

cpatTaskList :: Lens' CountPendingActivityTasks TaskList

The name of the task list.

Destructuring the Response

pendingTaskCount

Arguments

:: Natural

ptcCount

-> PendingTaskCount

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

Contains the count of tasks in a task list.

See: pendingTaskCount smart constructor.

Instances

Eq PendingTaskCount

Methods

(==) :: PendingTaskCount -> PendingTaskCount -> Bool

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

Data PendingTaskCount

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

Methods

readsPrec :: Int -> ReadS PendingTaskCount

readList :: ReadS [PendingTaskCount]

readPrec :: ReadPrec PendingTaskCount

readListPrec :: ReadPrec [PendingTaskCount]

Show PendingTaskCount

Methods

showsPrec :: Int -> PendingTaskCount -> ShowS

show :: PendingTaskCount -> String

showList :: [PendingTaskCount] -> ShowS

Generic PendingTaskCount

Associated Types

type Rep PendingTaskCount :: * -> *

Methods

from :: PendingTaskCount -> Rep PendingTaskCount x

to :: Rep PendingTaskCount x -> PendingTaskCount

Hashable PendingTaskCount

Methods

hashWithSalt :: Int -> PendingTaskCount -> Int

hash :: PendingTaskCount -> Int

FromJSON PendingTaskCount

Methods

parseJSON :: Value -> Parser PendingTaskCount

parseJSONList :: Value -> Parser [PendingTaskCount]

NFData PendingTaskCount

Methods

rnf :: PendingTaskCount -> ()

type Rep PendingTaskCount

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

Response Lenses

ptcTruncated :: Lens' PendingTaskCount (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.

ptcCount :: Lens' PendingTaskCount Natural

The number of tasks in the task list.