DeadlineCloud / Paginator / ListSessionActions


class DeadlineCloud.Paginator.ListSessionActions#
paginator = client.get_paginator('list_session_actions')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • farmId (string) –


    The farm ID for the session actions list.

  • jobId (string) –


    The job ID for the session actions list.

  • queueId (string) –


    The queue ID for the session actions list.

  • sessionId (string) – The session ID to include on the sessions action list.

  • taskId (string) – The task ID for the session actions list.

  • 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:



Response Syntax

    'sessionActions': [
            'definition': {
                'envEnter': {
                    'environmentId': 'string'
                'envExit': {
                    'environmentId': 'string'
                'syncInputJobAttachments': {
                    'stepId': 'string'
                'taskRun': {
                    'stepId': 'string',
                    'taskId': 'string'
            'endedAt': datetime(2015, 1, 1),
            'progressPercent': ...,
            'sessionActionId': 'string',
            'startedAt': datetime(2015, 1, 1),
            'workerUpdatedAt': datetime(2015, 1, 1)
    'NextToken': 'string'

Response Structure

  • (dict) –

    • sessionActions (list) –

      The session actions.

      • (dict) –

        The details of a session action.

        • definition (dict) –

          The session action definition.


          This is a Tagged Union structure. Only one of the following top level keys will be set: envEnter, envExit, syncInputJobAttachments, taskRun. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
          • envEnter (dict) –

            The environment to enter into.

            • environmentId (string) –

              The environment ID.

          • envExit (dict) –

            The environment to exit from.

            • environmentId (string) –

              The environment ID.

          • syncInputJobAttachments (dict) –

            The job attachments to sync with the session action definition.

            • stepId (string) –

              The step ID of the step in the job attachment.

          • taskRun (dict) –

            The task run.

            • stepId (string) –

              The step ID.

            • taskId (string) –

              The task ID.

        • endedAt (datetime) –

          The date and time the resource ended running.

        • progressPercent (float) –

          The completion percentage for the session action.

        • sessionActionId (string) –

          The session action ID.

        • startedAt (datetime) –

          The date and time the resource started running.

        • status (string) –

          The status of the session action.

        • workerUpdatedAt (datetime) –

          The Linux timestamp of the last date and time that the session action was updated.

    • NextToken (string) –

      A token to resume pagination.