Skip to content

ListTasksRequest

Source code in docs_src/capo_datasync/types/list_tasks_request.py
class ListTasksRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_datasync.types.max_results.MaxResults"]
    """<p>The maximum number of tasks to return.</p>"""
    next_token: NotRequired["capo_datasync.types.next_token.NextToken"]
    """<p>An opaque string that indicates the position at which to begin the next list of tasks.</p>"""
    filters: NotRequired["capo_datasync.types.task_filters.TaskFilters"]
    """<p>You can use API filters to narrow down the list of resources returned by <code>ListTasks</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListTasks</code> with filter name <code>LocationId</code> and <code>Operator Equals</code> with the ARN for the location.</p>"""

filters instance-attribute

filters: NotRequired[TaskFilters]

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of tasks to return.

next_token instance-attribute

next_token: NotRequired[NextToken]

An opaque string that indicates the position at which to begin the next list of tasks.