DeadlineCloud / Paginator / ListSessionActions

ListSessionActions

class DeadlineCloud.Paginator.ListSessionActions

paginator = client.get_paginator('list_session_actions')

paginate(**kwargs)

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(
    farmId='string',
    queueId='string',
    jobId='string',
    sessionId='string',
    taskId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID for the session actions list.

• queueId (string) –

  [REQUIRED]

  The queue ID for the session actions list.

• jobId (string) –

  [REQUIRED]

  The job 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:

dict

Returns:

Response Syntax

{
    'sessionActions': [
        {
            'sessionActionId': 'string',
            'status': 'ASSIGNED'|'RUNNING'|'CANCELING'|'SUCCEEDED'|'FAILED'|'INTERRUPTED'|'CANCELED'|'NEVER_ATTEMPTED'|'SCHEDULED'|'RECLAIMING'|'RECLAIMED',
            'startedAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'workerUpdatedAt': datetime(2015, 1, 1),
            'progressPercent': ...,
            'definition': {
                'envEnter': {
                    'environmentId': 'string'
                },
                'envExit': {
                    'environmentId': 'string'
                },
                'taskRun': {
                    'taskId': 'string',
                    'stepId': 'string'
                },
                'syncInputJobAttachments': {
                    'stepId': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • sessionActions (list) –

    The session actions.

    • (dict) –

      The details of a session action.

      • sessionActionId (string) –

        The session action ID.

      • status (string) –

        The status of the session action.

      • startedAt (datetime) –

        The date and time the resource started running.

      • endedAt (datetime) –

        The date and time the resource ended running.

      • workerUpdatedAt (datetime) –

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

      • progressPercent (float) –

        The completion percentage for the session action.

      • definition (dict) –

        The session action definition.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: envEnter, envExit, taskRun, syncInputJobAttachments. 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.

        • taskRun (dict) –

          The task run.

          • taskId (string) –

            The task ID.

          • stepId (string) –

            The step 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.

  • NextToken (string) –

    A token to resume pagination.