MainframeModernization / Client / get_batch_job_execution

get_batch_job_execution

MainframeModernization.Client.get_batch_job_execution(**kwargs)

Gets the details of a specific batch job execution for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.get_batch_job_execution(
    applicationId='string',
    executionId='string'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the application.

• executionId (string) –

  [REQUIRED]

  The unique identifier of the batch job execution.

Return type:

dict

Returns:

Response Syntax

{
    'applicationId': 'string',
    'batchJobIdentifier': {
        'fileBatchJobIdentifier': {
            'fileName': 'string',
            'folderPath': 'string'
        },
        'scriptBatchJobIdentifier': {
            'scriptName': 'string'
        }
    },
    'endTime': datetime(2015, 1, 1),
    'executionId': 'string',
    'jobId': 'string',
    'jobName': 'string',
    'jobType': 'VSE'|'JES2'|'JES3',
    'jobUser': 'string',
    'returnCode': 'string',
    'startTime': datetime(2015, 1, 1),
    'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning',
    'statusReason': 'string'
}

Response Structure

• (dict) –

  • applicationId (string) –

    The identifier of the application.

  • batchJobIdentifier (dict) –

    The unique identifier of this batch job.

    Note

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

    • fileBatchJobIdentifier (dict) –

      Specifies a file associated with a specific batch job.

      • fileName (string) –

        The file name for the batch job identifier.

      • folderPath (string) –

        The relative path to the file name for the batch job identifier.

    • scriptBatchJobIdentifier (dict) –

      A batch job identifier in which the batch job to run is identified by the script name.

      • scriptName (string) –

        The name of the script containing the batch job definition.

  • endTime (datetime) –

    The timestamp when the batch job execution ended.

  • executionId (string) –

    The unique identifier for this batch job execution.

  • jobId (string) –

    The unique identifier for this batch job.

  • jobName (string) –

    The name of this batch job.

  • jobType (string) –

    The type of job.

  • jobUser (string) –

    The user for the job.

  • returnCode (string) –

    The batch job return code from either the Blu Age or Micro Focus runtime engines. For more information, see Batch return codes in the IBM WebSphere Application Server documentation.

  • startTime (datetime) –

    The timestamp when the batch job execution started.

  • status (string) –

    The status of the batch job execution.

  • statusReason (string) –

    The reason for the reported status.

Exceptions

• MainframeModernization.Client.exceptions.ResourceNotFoundException

• MainframeModernization.Client.exceptions.ThrottlingException

• MainframeModernization.Client.exceptions.AccessDeniedException

• MainframeModernization.Client.exceptions.ValidationException

• MainframeModernization.Client.exceptions.InternalServerException