MainframeModernization / Client / list_batch_job_executions

list_batch_job_executions

MainframeModernization.Client.list_batch_job_executions(**kwargs)

Lists historical, current, and scheduled batch job executions for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.list_batch_job_executions(
    applicationId='string',
    executionIds=[
        'string',
    ],
    jobName='string',
    maxResults=123,
    nextToken='string',
    startedAfter=datetime(2015, 1, 1),
    startedBefore=datetime(2015, 1, 1),
    status='Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning'
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The unique identifier of the application.

• executionIds (list) –

  The unique identifier of each batch job execution.

  • (string) –

• jobName (string) – The name of each batch job execution.

• maxResults (integer) – The maximum number of batch job executions to return.

• nextToken (string) – A pagination token to control the number of batch job executions displayed in the list.

• startedAfter (datetime) – The time after which the batch job executions started.

• startedBefore (datetime) – The time before the batch job executions started.

• status (string) – The status of the batch job executions.

Return type:

dict

Returns:

Response Syntax

{
    'batchJobExecutions': [
        {
            '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',
            'returnCode': 'string',
            'startTime': datetime(2015, 1, 1),
            'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Succeeded With Warning'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • batchJobExecutions (list) –

    Returns a list of batch job executions for an application.

    • (dict) –

      A subset of the possible batch job attributes. Used in the batch job list.

      • applicationId (string) –

        The unique identifier of the application that hosts this batch job.

      • 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 this batch job execution ended.

      • executionId (string) –

        The unique identifier of this execution of the batch job.

      • jobId (string) –

        The unique identifier of a particular batch job.

      • jobName (string) –

        The name of a particular batch job.

      • jobType (string) –

        The type of a particular batch job execution.

      • 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 a particular batch job execution started.

      • status (string) –

        The status of a particular batch job execution.

  • nextToken (string) –

    A pagination token that’s returned when the response doesn’t contain all batch job executions.

Exceptions

• MainframeModernization.Client.exceptions.ValidationException

• MainframeModernization.Client.exceptions.InternalServerException

• MainframeModernization.Client.exceptions.AccessDeniedException

• MainframeModernization.Client.exceptions.ThrottlingException

• MainframeModernization.Client.exceptions.ResourceNotFoundException