Skip to content

ListSessionsRequest

Source code in docs_src/capo_nova_act/types/list_sessions_request.py
class ListSessionsRequest(TypedDict, closed=True):
    workflow_definition_name: (
        "capo_nova_act.types.workflow_definition_name.WorkflowDefinitionName"
    )
    """<p>The name of the workflow definition containing the workflow run.</p>"""
    workflow_run_id: "capo_nova_act.types.uuid_string.UuidString"
    """<p>The unique identifier of the workflow run to list sessions for.</p>"""
    max_results: NotRequired["capo_nova_act.types.max_results.MaxResults"]
    """<p>The maximum number of sessions to return in a single response.</p>"""
    next_token: NotRequired["capo_nova_act.types.next_token.NextToken"]
    """<p>The token for retrieving the next page of results.</p>"""
    sort_order: NotRequired["capo_nova_act.types.sort_order.SortOrder"]
    """<p>The sort order for the returned sessions (ascending or descending).</p>"""

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of sessions to return in a single response.

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for retrieving the next page of results.

sort_order instance-attribute

sort_order: NotRequired[SortOrder]

The sort order for the returned sessions (ascending or descending).

workflow_definition_name instance-attribute

workflow_definition_name: WorkflowDefinitionName

The name of the workflow definition containing the workflow run.

workflow_run_id instance-attribute

workflow_run_id: UuidString

The unique identifier of the workflow run to list sessions for.