Skip to content

ListQueuesRequest

Source code in docs_src/capo_deadline/types/list_queues_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListQueuesRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID of the queue.</p>"""
    next_token: NotRequired["capo_deadline.types.next_token.NextToken"]
    """<p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>"""
    max_results: "capo_deadline.types.max_results.MaxResults"
    """<p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>"""
    principal_id: NotRequired[
        "capo_deadline.types.identity_center_principal_id.IdentityCenterPrincipalId"
    ]
    """<p>The principal IDs to include in the list of queues.</p>"""
    status: NotRequired["capo_deadline.types.queue_status.QueueStatus"]
    """<p>The status of the queues listed.</p> <ul> <li> <p> <code>ACTIVE</code>–The queues are active.</p> </li> <li> <p> <code>SCHEDULING</code>–The queues are scheduling.</p> </li> <li> <p> <code>SCHEDULING_BLOCKED</code>–The queue scheduling is blocked for these queues.</p> </li> </ul>"""

farm_id instance-attribute 

farm_id: FarmId

The farm ID of the queue.

max_results instance-attribute 

max_results: MaxResults

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

next_token instance-attribute 

next_token: NotRequired[NextToken]

The token for the next set of results, or null to start from the beginning.

principal_id instance-attribute 

principal_id: NotRequired[IdentityCenterPrincipalId]

The principal IDs to include in the list of queues.

status instance-attribute 

status: NotRequired[QueueStatus]

The status of the queues listed.

  • ACTIVE–The queues are active.

  • SCHEDULING–The queues are scheduling.

  • SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.