MainframeModernization / Client / start_batch_job

start_batch_job#

MainframeModernization.Client.start_batch_job(**kwargs)#

Starts a batch job and returns the unique identifier of this execution of the batch job. The associated application must be running in order to start the batch job.

Request Syntax

response = client.start_batch_job(
    applicationId='string',
    batchJobIdentifier={
        'fileBatchJobIdentifier': {
            'fileName': 'string',
            'folderPath': 'string'
        },
        'restartBatchJobIdentifier': {
            'executionId': 'string',
            'jobStepRestartMarker': {
                'fromProcStep': 'string',
                'fromStep': 'string',
                'toProcStep': 'string',
                'toStep': 'string'
            }
        },
        's3BatchJobIdentifier': {
            'bucket': 'string',
            'identifier': {
                'fileName': 'string',
                'scriptName': 'string'
            },
            'keyPrefix': 'string'
        },
        'scriptBatchJobIdentifier': {
            'scriptName': 'string'
        }
    },
    jobParams={
        'string': 'string'
    }
)

Parameters:

applicationId (string) –
[REQUIRED]

The unique identifier of the application associated with this batch job.
batchJobIdentifier (dict) –
[REQUIRED]

The unique identifier of the batch job.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: fileBatchJobIdentifier, restartBatchJobIdentifier, s3BatchJobIdentifier, scriptBatchJobIdentifier.
- fileBatchJobIdentifier (dict) –
  
  Specifies a file associated with a specific batch job.
  - fileName (string) – [REQUIRED]
    
    The file name for the batch job identifier.
  - folderPath (string) –
    
    The relative path to the file name for the batch job identifier.
- restartBatchJobIdentifier (dict) –
  
  Specifies the required information for restart, including execution ID and jobsteprestartmarker.
  - executionId (string) – [REQUIRED]
    
    The executionId from the StartBatchJob response when the job ran for the first time.
  - jobStepRestartMarker (dict) – [REQUIRED]
    
    The restart step information for the most recent restart operation.
    - fromProcStep (string) –
      
      The procedure step name that a job was restarted from.
    - fromStep (string) – [REQUIRED]
      
      The step name that a batch job restart was from.
    - toProcStep (string) –
      
      The procedure step name that a batch job was restarted to.
    - toStep (string) –
      
      The step name that a job was restarted to.
- s3BatchJobIdentifier (dict) –
  
  Specifies an Amazon S3 location that identifies the batch jobs that you want to run. Use this identifier to run ad hoc batch jobs.
  - bucket (string) – [REQUIRED]
    
    The Amazon S3 bucket that contains the batch job definitions.
  - identifier (dict) – [REQUIRED]
    
    Identifies the batch job definition. This identifier can also point to any batch job definition that already exists in the application or to one of the batch job definitions within the directory that is specified in keyPrefix.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: fileName, scriptName.
    - fileName (string) –
      
      The name of the file that contains the batch job definition.
    - scriptName (string) –
      
      The name of the script that contains the batch job definition.
  - keyPrefix (string) –
    
    The key prefix that specifies the path to the folder in the S3 bucket that has the batch job definitions.
- scriptBatchJobIdentifier (dict) –
  
  A batch job identifier in which the batch job to run is identified by the script name.
  - scriptName (string) – [REQUIRED]
    
    The name of the script containing the batch job definition.
jobParams (dict) –
The collection of batch job parameters. For details about limits for keys and values, see Coding variables in JCL.
- (string) –
  
  See https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl to get details about limits for both keys and values: 8 for keys (variable names), 44 for values (variable values) In addition, keys will be only alphabetic characters and digits, without any space or special characters (dash, underscore, etc …)
  
  Parameter key: the first character must be alphabetic. Can be of up to 8 alphanumeric characters.
  - (string) –
    
    Parameter value can be of up to 44 alphanumeric characters.

Return type:

dict

Returns:

Response Syntax

{
    'executionId': 'string'
}

Response Structure

(dict) –
- executionId (string) –
  
  The unique identifier of this execution of the batch job.

Exceptions

MainframeModernization.Client.exceptions.ResourceNotFoundException
MainframeModernization.Client.exceptions.ThrottlingException
MainframeModernization.Client.exceptions.AccessDeniedException
MainframeModernization.Client.exceptions.ConflictException
MainframeModernization.Client.exceptions.ValidationException
MainframeModernization.Client.exceptions.InternalServerException