count_pending_activity_tasks ¶

def count_pending_activity_tasks(
    self,
    domain: "capo_swf.types.domain_name.DomainName",
    task_list: "capo_swf.types.task_list.TaskList",
    *,
    config_overrides: Optional[SWFClientConfig] = None,
) -> "capo_swf.types.pending_task_count.PendingTaskCount":
    """<p>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 <code>0</code> is returned.</p> <p> <b>Access Control</b> </p> <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p> <ul> <li> <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</p> </li> <li> <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p> </li> <li> <p>Constrain the <code>taskList.name</code> parameter by using a <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</p> </li> </ul> <p>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 <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>. For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>

    Args:
        domain: <p>The name of the domain that contains the task list.</p>
        task_list: <p>The name of the task list.</p>

    Raises:
        capo_swf.errors.operation_not_permitted_fault.OperationNotPermittedFault: <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
        capo_swf.errors.unknown_resource_fault.UnknownResourceFault: <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
        capo_swf.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_swf.types.count_pending_activity_tasks_input.CountPendingActivityTasksInput]",
    ) -> OperationResponse["capo_swf.types.pending_task_count.PendingTaskCount"]:
        import capo_swf._operations.simple_workflow_service.count_pending_activity_tasks

        output, http_response = (
            capo_swf._operations.simple_workflow_service.count_pending_activity_tasks.count_pending_activity_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CountPendingActivityTasks")
    )
    input_: capo_swf.types.count_pending_activity_tasks_input.CountPendingActivityTasksInput = {
        "domain": domain,
        "task_list": task_list,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output