DeadlineCloud / Client / batch_get_session_action

batch_get_session_action¶

DeadlineCloud.Client.batch_get_session_action(**kwargs)¶

Retrieves multiple session actions in a single request. This is a batch version of the GetSessionAction API.

The result of getting each session action is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Request Syntax

response = client.batch_get_session_action(
    identifiers=[
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'sessionActionId': 'string'
        },
    ]
)

Parameters:

identifiers (list) –

[REQUIRED]

The list of session action identifiers to retrieve. You can specify up to 100 identifiers per request.

(dict) –

The identifiers for a session action.
- farmId (string) – [REQUIRED]
  
  The farm ID of the session action.
- queueId (string) – [REQUIRED]
  
  The queue ID of the session action.
- jobId (string) – [REQUIRED]
  
  The job ID of the session action.
- sessionActionId (string) – [REQUIRED]
  
  The session action ID.

Return type:

dict

Returns:

Response Syntax

{
    'sessionActions': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            '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': ...,
            'manifests': [
                {
                    'outputManifestPath': 'string',
                    'outputManifestHash': 'string'
                },
            ],
            'sessionId': 'string',
            'processExitCode': 123,
            'progressMessage': 'string',
            'acquiredLimits': [
                {
                    'limitId': 'string',
                    'count': 123
                },
            ],
            'definition': {
                'envEnter': {
                    'environmentId': 'string'
                },
                'envExit': {
                    'environmentId': 'string'
                },
                'taskRun': {
                    'taskId': 'string',
                    'stepId': 'string',
                    'parameters': {
                        'string': {
                            'int': 'string',
                            'float': 'string',
                            'string': 'string',
                            'path': 'string',
                            'chunkInt': 'string'
                        }
                    }
                },
                'syncInputJobAttachments': {
                    'stepId': 'string'
                }
            }
        },
    ],
    'errors': [
        {
            'farmId': 'string',
            'queueId': 'string',
            'jobId': 'string',
            'sessionActionId': 'string',
            'code': 'InternalServerErrorException'|'ResourceNotFoundException'|'ValidationException',
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- sessionActions (list) –
  
  A list of session actions that were successfully retrieved.
  - (dict) –
    
    The details of a session action returned in a batch get operation.
    - farmId (string) –
      
      The farm ID of the session action.
    - queueId (string) –
      
      The queue ID of the session action.
    - jobId (string) –
      
      The job ID of the 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 date and time the resource was updated by a worker.
    - progressPercent (float) –
      
      The completion percentage for the session action.
    - manifests (list) –
      
      The manifests for the session action.
      - (dict) –
        
        The manifest properties for a task run, corresponding to the manifest properties in the job.
        
        outputManifestPath (string) –
        
        The manifest file path.
        
        outputManifestHash (string) –
        
        The hash value of the file.
    - sessionId (string) –
      
      The session ID for the session action.
    - processExitCode (integer) –
      
      The exit code to apply to the session action.
    - progressMessage (string) –
      
      The message that communicates the progress of the session action.
    - acquiredLimits (list) –
      
      The limits that were acquired for the session action.
      - (dict) –
        
        Provides information about the number of resources used.
        
        limitId (string) –
        
        The unique identifier of the limit.
        
        count (integer) –
        
        The number of limit resources used.
    - 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, chunkInt. 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.
        
        chunkInt (string) –
        
        A range (for example 1-10) or selection of specific (for example 1,3,7,8,10) integers represented as a string.
      - syncInputJobAttachments (dict) –
        
        The session action definition for syncing input job attachments.
        
        stepId (string) –
        
        The step ID for the sync input job attachments session action.
- errors (list) –
  
  A list of errors for session actions that could not be retrieved.
  - (dict) –
    
    The error details for a session action that could not be retrieved in a batch get operation.
    - farmId (string) –
      
      The farm ID of the session action that could not be retrieved.
    - queueId (string) –
      
      The queue ID of the session action that could not be retrieved.
    - jobId (string) –
      
      The job ID of the session action that could not be retrieved.
    - sessionActionId (string) –
      
      The session action ID of the session action that could not be retrieved.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.