Skip to content

ListStepsRequest

Source code in docs_src/capo_deadline/types/list_steps_request.py
class ListStepsRequest(TypedDict, closed=True):
    farm_id: "capo_deadline.types.farm_id.FarmId"
    """<p>The farm ID to include on the list of steps.</p>"""
    queue_id: "capo_deadline.types.queue_id.QueueId"
    """<p>The queue ID to include on the list of steps.</p>"""
    job_id: "capo_deadline.types.job_id.JobId"
    """<p>The job ID to include on the list of steps.</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>"""

farm_id instance-attribute

farm_id: FarmId

The farm ID to include on the list of steps.

job_id instance-attribute

job_id: JobId

The job ID to include on the list of steps.

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.

queue_id instance-attribute

queue_id: QueueId

The queue ID to include on the list of steps.