DeadlineCloud / Client / get_session_action

get_session_action#

DeadlineCloud.Client.get_session_action(**kwargs)#

Gets a session action for the job.

See also: AWS API Documentation

Request Syntax

response = client.get_session_action(
    farmId='string',
    queueId='string',
    jobId='string',
    sessionActionId='string'
)
Parameters:

  • farmId (string) –

    [REQUIRED]

    The farm ID for the session action.

  • queueId (string) –

    [REQUIRED]

    The queue ID for the session action.

  • jobId (string) –

    [REQUIRED]

    The job ID for the session.

  • sessionActionId (string) –

    [REQUIRED]

    The session action ID for the session.

Return type:

dict

Returns:

Response Syntax

{
    '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': ...,
    'sessionId': 'string',
    'processExitCode': 123,
    'progressMessage': 'string',
    'definition': {
        'envEnter': {
            'environmentId': 'string'
        },
        'envExit': {
            'environmentId': 'string'
        },
        'taskRun': {
            'taskId': 'string',
            'stepId': 'string',
            'parameters': {
                'string': {
                    'int': 'string',
                    'float': 'string',
                    'string': 'string',
                    'path': 'string'
                }
            }
        },
        'syncInputJobAttachments': {
            'stepId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • 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 date and time the session action was last updated.

    • progressPercent (float) –

      The percentage completed for a session action.

    • sessionId (string) –

      The session ID for the session action.

    • processExitCode (integer) –

      The exit code to exit the session.

    • progressMessage (string) –

      The message that communicates the progress of 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 in the session.

        • taskId (string) –

          The task ID.

        • stepId (string) –

          The step ID.

        • parameters (dict) –

          The task parameters.

          • (string) –

            • (dict) –

              The data types for the task parameters.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: int, float, string, path. 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'}

              • int (string) –

                A signed integer represented as a string.

              • float (string) –

                A double precision IEEE-754 floating point number represented as a string.

              • string (string) –

                A UTF-8 string.

              • path (string) –

                A file system path represented as a string.

      • syncInputJobAttachments (dict) –

        The job attachments to sync with a session action.

        • stepId (string) –

          The step ID for the step in the job attachment.

Exceptions