AWS API Changes

2024/04/16 - AWSMainframeModernization - 1 new3 updated api methods

Changes Adding new ListBatchJobRestartPoints API and support for restart batch job.

ListBatchJobRestartPoints (new)

Link ¶

Lists all the job steps for JCL files to restart a batch job. This is only applicable for Micro Focus engine with versions 8.0.6 and above.

See also: AWS API Documentation

Request Syntax

client.list_batch_job_restart_points(
    applicationId='string',
    executionId='string'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The unique identifier of the application.

type executionId:

string

param executionId:

[REQUIRED]

The unique identifier of each batch job execution.

rtype:

dict

returns:

Response Syntax

{
    'batchJobSteps': [
        {
            'procStepName': 'string',
            'procStepNumber': 123,
            'stepCondCode': 'string',
            'stepName': 'string',
            'stepNumber': 123,
            'stepRestartable': True|False
        },
    ]
}

Response Structure

(dict) --
- batchJobSteps (list) --
  
  Returns all the batch job steps and related information for a batch job that previously ran.
  - (dict) --
    
    Provides information related to a job step.
    - procStepName (string) --
      
      The name of a procedure step.
    - procStepNumber (integer) --
      
      The number of a procedure step.
    - stepCondCode (string) --
      
      The condition code of a step.
    - stepName (string) --
      
      The name of a step.
    - stepNumber (integer) --
      
      The number of a step.
    - stepRestartable (boolean) --
      
      Specifies if a step can be restarted or not.

GetBatchJobExecution (updated)

Link ¶
Changes (response)

{'batchJobIdentifier': {'restartBatchJobIdentifier': {'executionId': 'string',
                                                      'jobStepRestartMarker': {'fromProcStep': 'string',
                                                                               'fromStep': 'string',
                                                                               'toProcStep': 'string',
                                                                               'toStep': 'string'}}},
 'jobStepRestartMarker': {'fromProcStep': 'string',
                          'fromStep': 'string',
                          'toProcStep': 'string',
                          'toStep': 'string'},
 'status': {'Purged'}}

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

See also: AWS API Documentation

Request Syntax

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

type applicationId:

string

param applicationId:

[REQUIRED]

The identifier of the application.

type executionId:

string

param executionId:

[REQUIRED]

The unique identifier of the batch job execution.

rtype:

dict

returns:

Response Syntax

{
    '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'
        }
    },
    'endTime': datetime(2015, 1, 1),
    'executionId': 'string',
    'jobId': 'string',
    'jobName': 'string',
    'jobStepRestartMarker': {
        'fromProcStep': 'string',
        'fromStep': 'string',
        'toProcStep': 'string',
        'toStep': 'string'
    },
    'jobType': 'VSE'|'JES2'|'JES3',
    'jobUser': 'string',
    'returnCode': 'string',
    'startTime': datetime(2015, 1, 1),
    'status': 'Submitting'|'Holding'|'Dispatching'|'Running'|'Cancelling'|'Cancelled'|'Succeeded'|'Failed'|'Purged'|'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, restartBatchJobIdentifier, s3BatchJobIdentifier, 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.
  - restartBatchJobIdentifier (dict) --
    
    Specifies the required information for restart, including execution ID and jobsteprestartmarker.
    - executionId (string) --
      
      The executionId from the StartBatchJob response when the job ran for the first time.
    - jobStepRestartMarker (dict) --
      
      The restart step information for the most recent restart operation.
      - fromProcStep (string) --
        
        The procedure step name that a job was restarted from.
      - fromStep (string) --
        
        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) --
      
      The Amazon S3 bucket that contains the batch job definitions.
    - identifier (dict) --
      
      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 will be set: fileName, scriptName. 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'}
      - 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) --
      
      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.
- jobStepRestartMarker (dict) --
  
  The restart steps information for the most recent restart operation.
  - fromProcStep (string) --
    
    The procedure step name that a job was restarted from.
  - fromStep (string) --
    
    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.
- 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.

ListBatchJobExecutions (updated)

Link ¶
Changes (request, response)
Request

{'status': {'Purged'}}

Response

{'batchJobExecutions': {'batchJobIdentifier': {'restartBatchJobIdentifier': {'executionId': 'string',
                                                                             'jobStepRestartMarker': {'fromProcStep': 'string',
                                                                                                      'fromStep': 'string',
                                                                                                      'toProcStep': 'string',
                                                                                                      'toStep': 'string'}}},
                        'status': {'Purged'}}}

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

See also: AWS API Documentation

Request Syntax

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'|'Purged'|'Succeeded With Warning'
)

type applicationId:

string

param applicationId:

[REQUIRED]

The unique identifier of the application.

type executionIds:

list

param executionIds:

The unique identifier of each batch job execution.

(string) --

type jobName:

string

param jobName:

The name of each batch job execution.

type maxResults:

integer

param maxResults:

The maximum number of batch job executions to return.

type nextToken:

string

param nextToken:

A pagination token to control the number of batch job executions displayed in the list.

type startedAfter:

datetime

param startedAfter:

The time after which the batch job executions started.

type startedBefore:

datetime

param startedBefore:

The time before the batch job executions started.

type status:

string

param status:

The status of the batch job executions.

rtype:

dict

returns:

Response Syntax

{
    'batchJobExecutions': [
        {
            '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'
                }
            },
            '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'|'Purged'|'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, restartBatchJobIdentifier, s3BatchJobIdentifier, 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.
      - restartBatchJobIdentifier (dict) --
        
        Specifies the required information for restart, including execution ID and jobsteprestartmarker.
        
        executionId (string) --
        
        The executionId from the StartBatchJob response when the job ran for the first time.
        
        jobStepRestartMarker (dict) --
        
        The restart step information for the most recent restart operation.
        
        fromProcStep (string) --
        
        The procedure step name that a job was restarted from.
        
        fromStep (string) --
        
        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) --
        
        The Amazon S3 bucket that contains the batch job definitions.
        
        identifier (dict) --
        
        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 will be set: fileName, scriptName. 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'}
        
        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) --
        
        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.

StartBatchJob (updated)

Link ¶
Changes (request)

{'batchJobIdentifier': {'restartBatchJobIdentifier': {'executionId': 'string',
                                                      'jobStepRestartMarker': {'fromProcStep': 'string',
                                                                               'fromStep': 'string',
                                                                               'toProcStep': 'string',
                                                                               'toStep': 'string'}}}}

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

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'
    }
)

type applicationId:

string

param applicationId:

[REQUIRED]

The unique identifier of the application associated with this batch job.

type batchJobIdentifier:

dict

param batchJobIdentifier:

[REQUIRED]

The unique identifier of the batch job.

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.

type jobParams:

dict

param jobParams:

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.

rtype:

dict

returns:

Response Syntax

{
    'executionId': 'string'
}

Response Structure

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