list_sessions async ¶

async def list_sessions(
    self,
    farm_id: "capo_deadline.types.farm_id.FarmId",
    queue_id: "capo_deadline.types.queue_id.QueueId",
    job_id: "capo_deadline.types.job_id.JobId",
    *,
    config_overrides: Optional[AsyncdeadlineClientConfig] = None,
    next_token: Optional["capo_deadline.types.next_token.NextToken"] = None,
    max_results: Optional["capo_deadline.types.max_results.MaxResults"] = None,
) -> "capo_deadline.types.list_sessions_response.ListSessionsResponse":
    """<p>Lists sessions.</p>

    Args:
        farm_id: <p>The farm ID for the list of sessions.</p>
        queue_id: <p>The queue ID for the list of sessions</p>
        job_id: <p>The job ID for the list of sessions.</p>
        next_token: <p>The token for the next set of results, or <code>null</code> to start from the beginning.</p>
        max_results: <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>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        (
            output,
            http_response,
        ) = await capo_deadline._operations.deadline.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_deadline.types.list_sessions_request.ListSessionsRequest = {
        "farm_id": farm_id,
        "queue_id": queue_id,
        "job_id": job_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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