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

Amazonka.SWF.CountPendingActivityTasks

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

data CountPendingActivityTasks Source #

See: newCountPendingActivityTasks smart constructor.

Constructors

CountPendingActivityTasks' 

Fields

Instances

Instances details
Eq CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

Read CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

Show CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

Generic CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

Associated Types

type Rep CountPendingActivityTasks :: Type -> Type #

NFData CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

Hashable CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

ToJSON CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

AWSRequest CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

ToHeaders CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

ToPath CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

ToQuery CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

type Rep CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

type Rep CountPendingActivityTasks = D1 ('MetaData "CountPendingActivityTasks" "Amazonka.SWF.CountPendingActivityTasks" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "CountPendingActivityTasks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskList)))
type AWSResponse CountPendingActivityTasks Source # 
Instance details

Defined in Amazonka.SWF.CountPendingActivityTasks

newCountPendingActivityTasks Source #

Create a value of CountPendingActivityTasks with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domain:CountPendingActivityTasks', countPendingActivityTasks_domain - The name of the domain that contains the task list.

$sel:taskList:CountPendingActivityTasks', countPendingActivityTasks_taskList - The name of the task list.

Request Lenses

countPendingActivityTasks_domain :: Lens' CountPendingActivityTasks Text Source #

The name of the domain that contains the task list.

Destructuring the Response

data PendingTaskCount Source #

Contains the count of tasks in a task list.

See: newPendingTaskCount smart constructor.

Constructors

PendingTaskCount' 

Fields

  • truncated :: 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.

  • count :: Natural

    The number of tasks in the task list.

Instances

Instances details
Eq PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

Read PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

Show PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

Generic PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

Associated Types

type Rep PendingTaskCount :: Type -> Type #

NFData PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

Methods

rnf :: PendingTaskCount -> () #

Hashable PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

FromJSON PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

type Rep PendingTaskCount Source # 
Instance details

Defined in Amazonka.SWF.Types.PendingTaskCount

type Rep PendingTaskCount = D1 ('MetaData "PendingTaskCount" "Amazonka.SWF.Types.PendingTaskCount" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "PendingTaskCount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "count") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newPendingTaskCount Source #

Create a value of PendingTaskCount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:truncated:PendingTaskCount', pendingTaskCount_truncated - 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.

$sel:count:PendingTaskCount', pendingTaskCount_count - The number of tasks in the task list.

Response Lenses

pendingTaskCount_truncated :: 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.

pendingTaskCount_count :: Lens' PendingTaskCount Natural Source #

The number of tasks in the task list.