start_batch_job

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.

See also: AWS API Documentation

Request Syntax

response = client.start_batch_job(
    applicationId='string',
    batchJobIdentifier={
        'fileBatchJobIdentifier': {
            'fileName': 'string',
            'folderPath': '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, 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.

    • 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) --

      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.ValidationException
  • MainframeModernization.Client.exceptions.ConflictException
  • MainframeModernization.Client.exceptions.InternalServerException
  • MainframeModernization.Client.exceptions.AccessDeniedException
  • MainframeModernization.Client.exceptions.ThrottlingException
  • MainframeModernization.Client.exceptions.ResourceNotFoundException