DeadlineCloud / Paginator / ListSessions

ListSessions#

class DeadlineCloud.Paginator.ListSessions#
paginator = client.get_paginator('list_sessions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DeadlineCloud.Client.list_sessions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    farmId='string',
    queueId='string',
    jobId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • farmId (string) –

    [REQUIRED]

    The farm ID for the list of sessions.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the list of sessions

  • jobId (string) –

    [REQUIRED]

    The job ID for the list of sessions.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'sessions': [
        {
            'sessionId': 'string',
            'fleetId': 'string',
            'workerId': 'string',
            'startedAt': datetime(2015, 1, 1),
            'lifecycleStatus': 'STARTED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCEEDED'|'UPDATE_FAILED'|'ENDED',
            'endedAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string',
            'targetLifecycleStatus': 'ENDED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • sessions (list) –

      The sessions on the list.

      • (dict) –

        The summary of a session.

        • sessionId (string) –

          The session ID.

        • fleetId (string) –

          The fleet ID.

        • workerId (string) –

          The worker ID.

        • startedAt (datetime) –

          The date and time the resource started running.

        • lifecycleStatus (string) –

          The life cycle status for the session.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • updatedAt (datetime) –

          The date and time the resource was updated.

        • updatedBy (string) –

          The user or system that updated this resource.

        • targetLifecycleStatus (string) –

          The target life cycle status for the session.

    • NextToken (string) –

      A token to resume pagination.