list_sessions async ¶

async def list_sessions(
    self,
    workflow_definition_name: "capo_nova_act.types.workflow_definition_name.WorkflowDefinitionName",
    workflow_run_id: "capo_nova_act.types.uuid_string.UuidString",
    *,
    config_overrides: Optional[AsyncNovaActClientConfig] = None,
    max_results: Optional["capo_nova_act.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_nova_act.types.next_token.NextToken"] = None,
    sort_order: Optional["capo_nova_act.types.sort_order.SortOrder"] = None,
) -> "capo_nova_act.types.list_sessions_response.ListSessionsResponse":
    """<p>Lists all sessions within a specific workflow run.</p>

    Args:
        workflow_definition_name: <p>The name of the workflow definition containing the workflow run.</p>
        workflow_run_id: <p>The unique identifier of the workflow run to list sessions for.</p>
        max_results: <p>The maximum number of sessions to return in a single response.</p>
        next_token: <p>The token for retrieving the next page of results.</p>
        sort_order: <p>The sort order for the returned sessions (ascending or descending).</p>

    Raises:
        capo_nova_act.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_nova_act.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource.</p>
        capo_nova_act.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Please try again later.</p>
        capo_nova_act.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_nova_act.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests. Please try again later.</p>
        capo_nova_act.errors.validation_exception.ValidationException: <p>The input parameters for the request are invalid.</p>
        capo_nova_act.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_nova_act.types.list_sessions_request.ListSessionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_nova_act.types.list_sessions_response.ListSessionsResponse"
    ]:
        import capo_nova_act._operations.amazon_nova_agents_data_plane.list_sessions

        (
            output,
            http_response,
        ) = await capo_nova_act._operations.amazon_nova_agents_data_plane.list_sessions.async_list_sessions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSessions")
    )
    input_: capo_nova_act.types.list_sessions_request.ListSessionsRequest = {
        "workflow_definition_name": workflow_definition_name,
        "workflow_run_id": workflow_run_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_order is not None:
        input_["sort_order"] = sort_order

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output