ListSessionsRequest ¶

class ListSessionsRequest(TypedDict, closed=True):
    work_group: "capo_athena.types.work_group_name.WorkGroupName"
    """<p>The workgroup to which the session belongs.</p>"""
    state_filter: NotRequired["capo_athena.types.session_state.SessionState"]
    """<p>A filter for a specific session state. A description of each state follows.</p> <p> <code>CREATING</code> - The session is being started, including acquiring resources.</p> <p> <code>CREATED</code> - The session has been started.</p> <p> <code>IDLE</code> - The session is able to accept a calculation.</p> <p> <code>BUSY</code> - The session is processing another task and is unable to accept a calculation.</p> <p> <code>TERMINATING</code> - The session is in the process of shutting down.</p> <p> <code>TERMINATED</code> - The session and its resources are no longer running.</p> <p> <code>DEGRADED</code> - The session has no healthy coordinators.</p> <p> <code>FAILED</code> - Due to a failure, the session and its resources are no longer running.</p>"""
    max_results: NotRequired["capo_athena.types.max_sessions_count.MaxSessionsCount"]
    """<p>The maximum number of sessions to return.</p>"""
    next_token: NotRequired[
        "capo_athena.types.session_manager_token.SessionManagerToken"
    ]
    """<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"""