| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
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
Resourceelement with the domain name to limit the action to only specified domains. - Use an
Actionelement to allow or deny permission to call this action. - Constrain the
taskList.nameparameter by using aConditionelement with theswf:taskList.namekey 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
- data CountPendingActivityTasks = CountPendingActivityTasks' {}
- newCountPendingActivityTasks :: Text -> TaskList -> CountPendingActivityTasks
- countPendingActivityTasks_domain :: Lens' CountPendingActivityTasks Text
- countPendingActivityTasks_taskList :: Lens' CountPendingActivityTasks TaskList
- data PendingTaskCount = PendingTaskCount' {}
- newPendingTaskCount :: Natural -> PendingTaskCount
- pendingTaskCount_truncated :: Lens' PendingTaskCount (Maybe Bool)
- pendingTaskCount_count :: Lens' PendingTaskCount Natural
Creating a Request
data CountPendingActivityTasks Source #
See: newCountPendingActivityTasks smart constructor.
Constructors
| CountPendingActivityTasks' | |
Instances
newCountPendingActivityTasks Source #
Arguments
| :: Text | |
| -> TaskList | |
| -> CountPendingActivityTasks |
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.
countPendingActivityTasks_taskList :: Lens' CountPendingActivityTasks TaskList Source #
The name of the task list.
Destructuring the Response
data PendingTaskCount Source #
Contains the count of tasks in a task list.
See: newPendingTaskCount smart constructor.
Constructors
| PendingTaskCount' | |
Instances
Arguments
| :: Natural | |
| -> PendingTaskCount |
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.