2025/04/10 - AWSMainframeModernization - 3 new4 updated api methods
Changes Introduce three new APIs: CreateDataSetExportTask, GetDataSetExportTask and ListDataSetExportHistory. Add support for batch restart for Blu Age applications.
Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
See also: AWS API Documentation
Request Syntax
client.get_data_set_export_task(
applicationId='string',
taskId='string'
)
string
[REQUIRED]
The application identifier.
string
[REQUIRED]
The task identifier returned by the CreateDataSetExportTask operation.
dict
Response Syntax
{
'kmsKeyArn': 'string',
'status': 'Creating'|'Running'|'Completed'|'Failed',
'statusReason': 'string',
'summary': {
'failed': 123,
'inProgress': 123,
'pending': 123,
'succeeded': 123,
'total': 123
},
'taskId': 'string'
}
Response Structure
(dict) --
kmsKeyArn (string) --
The identifier of a customer managed key used for exported data set encryption.
status (string) --
The status of the task.
statusReason (string) --
If dataset export failed, the failure reason will show here.
summary (dict) --
A summary of the status of the task.
failed (integer) --
The number of data set exports that have failed.
inProgress (integer) --
The number of data set exports that are in progress.
pending (integer) --
The number of data set exports that are pending.
succeeded (integer) --
The number of data set exports that have succeeded.
total (integer) --
The total number of data set exports.
taskId (string) --
The task identifier.
Lists the data set exports for the specified application.
See also: AWS API Documentation
Request Syntax
client.list_data_set_export_history(
applicationId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier of the application.
integer
The maximum number of objects to return.
string
A pagination token returned from a previous call to this operation. This specifies the next item to return. To return to the beginning of the list, exclude this parameter.
dict
Response Syntax
{
'dataSetExportTasks': [
{
'status': 'Creating'|'Running'|'Completed'|'Failed',
'statusReason': 'string',
'summary': {
'failed': 123,
'inProgress': 123,
'pending': 123,
'succeeded': 123,
'total': 123
},
'taskId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataSetExportTasks (list) --
The data set export tasks.
(dict) --
Contains information about a data set export task.
status (string) --
The status of the data set export task.
statusReason (string) --
If dataset exports failed, the failure reason will show here.
summary (dict) --
A summary of the data set export task.
failed (integer) --
The number of data set exports that have failed.
inProgress (integer) --
The number of data set exports that are in progress.
pending (integer) --
The number of data set exports that are pending.
succeeded (integer) --
The number of data set exports that have succeeded.
total (integer) --
The total number of data set exports.
taskId (string) --
The identifier of the data set export task.
nextToken (string) --
If there are more items to return, this contains a token that is passed to a subsequent call to this operation to retrieve the next set of items.
Starts a data set export task for a specific application.
See also: AWS API Documentation
Request Syntax
client.create_data_set_export_task(
applicationId='string',
clientToken='string',
exportConfig={
'dataSets': [
{
'datasetName': 'string',
'externalLocation': {
's3Location': 'string'
}
},
],
's3Location': 'string'
},
kmsKeyId='string'
)
string
[REQUIRED]
The unique identifier of the application for which you want to export data sets.
string
Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.
This field is autopopulated if not provided.
dict
[REQUIRED]
The data set export task configuration.
dataSets (list) --
The data sets.
(dict) --
Identifies a specific data set to export from an external location.
datasetName (string) -- [REQUIRED]
The data set.
externalLocation (dict) -- [REQUIRED]
The location of the data set.
s3Location (string) --
The URI of the Amazon S3 bucket.
s3Location (string) --
The Amazon S3 location of the data sets.
string
The identifier of a customer managed key.
dict
Response Syntax
{
'taskId': 'string'
}
Response Structure
(dict) --
taskId (string) --
The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.
{'batchJobIdentifier': {'restartBatchJobIdentifier': {'jobStepRestartMarker': {'skip': 'boolean',
'stepCheckpoint': 'integer'}}},
'jobStepRestartMarker': {'skip': 'boolean', 'stepCheckpoint': 'integer'}}
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'
)
string
[REQUIRED]
The identifier of the application.
string
[REQUIRED]
The unique identifier of the batch job execution.
dict
Response Syntax
{
'applicationId': 'string',
'batchJobIdentifier': {
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
'restartBatchJobIdentifier': {
'executionId': 'string',
'jobStepRestartMarker': {
'fromProcStep': 'string',
'fromStep': 'string',
'skip': True|False,
'stepCheckpoint': 123,
'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',
'skip': True|False,
'stepCheckpoint': 123,
'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.
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 executionId and JobStepRestartMarker.
executionId (string) --
The executionId from the StartBatchJob response when the job ran for the first time.
jobStepRestartMarker (dict) --
The step/procedure step information for a restart batch job operation.
fromProcStep (string) --
The procedure step name that a batch job was restarted from.
fromStep (string) --
The step name that a batch job was restarted from.
skip (boolean) --
The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.
stepCheckpoint (integer) --
Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.
toProcStep (string) --
The procedure step name that a batch job was restarted to.
toStep (string) --
The step name that a batch 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.
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 step/procedure step information for the restart batch job operation.
fromProcStep (string) --
The procedure step name that a batch job was restarted from.
fromStep (string) --
The step name that a batch job was restarted from.
skip (boolean) --
The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.
stepCheckpoint (integer) --
Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.
toProcStep (string) --
The procedure step name that a batch job was restarted to.
toStep (string) --
The step name that a batch 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.
{'batchJobExecutions': {'batchJobIdentifier': {'restartBatchJobIdentifier': {'jobStepRestartMarker': {'skip': 'boolean',
'stepCheckpoint': 'integer'}}}}}
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'
)
string
[REQUIRED]
The unique identifier of the application.
list
The unique identifier of each batch job execution.
(string) --
string
The name of each batch job execution.
integer
The maximum number of batch job executions to return.
string
A pagination token to control the number of batch job executions displayed in the list.
datetime
The time after which the batch job executions started.
datetime
The time before the batch job executions started.
string
The status of the batch job executions.
dict
Response Syntax
{
'batchJobExecutions': [
{
'applicationId': 'string',
'batchJobIdentifier': {
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
'restartBatchJobIdentifier': {
'executionId': 'string',
'jobStepRestartMarker': {
'fromProcStep': 'string',
'fromStep': 'string',
'skip': True|False,
'stepCheckpoint': 123,
'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.
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 executionId and JobStepRestartMarker.
executionId (string) --
The executionId from the StartBatchJob response when the job ran for the first time.
jobStepRestartMarker (dict) --
The step/procedure step information for a restart batch job operation.
fromProcStep (string) --
The procedure step name that a batch job was restarted from.
fromStep (string) --
The step name that a batch job was restarted from.
skip (boolean) --
The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.
stepCheckpoint (integer) --
Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.
toProcStep (string) --
The procedure step name that a batch job was restarted to.
toStep (string) --
The step name that a batch 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.
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.
{'batchJobSteps': {'stepCheckpoint': 'integer',
'stepCheckpointStatus': 'string',
'stepCheckpointTime': 'timestamp'}}
Lists all the job steps for a JCL file 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',
authSecretsManagerArn='string',
executionId='string'
)
string
[REQUIRED]
The unique identifier of the application.
string
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for List Batch Job Restart Points operation.
string
[REQUIRED]
The unique identifier of the batch job execution.
dict
Response Syntax
{
'batchJobSteps': [
{
'procStepName': 'string',
'procStepNumber': 123,
'stepCheckpoint': 123,
'stepCheckpointStatus': 'string',
'stepCheckpointTime': datetime(2015, 1, 1),
'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.
stepCheckpoint (integer) --
A registered step-level checkpoint identifier that can be used for restarting an Amazon Web Services Blu Age application batch job.
stepCheckpointStatus (string) --
The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
stepCheckpointTime (datetime) --
The step-level checkpoint status for an Amazon Web Services Blu Age application batch job.
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.
{'batchJobIdentifier': {'restartBatchJobIdentifier': {'jobStepRestartMarker': {'skip': 'boolean',
'stepCheckpoint': 'integer'}}}}
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',
authSecretsManagerArn='string',
batchJobIdentifier={
'fileBatchJobIdentifier': {
'fileName': 'string',
'folderPath': 'string'
},
'restartBatchJobIdentifier': {
'executionId': 'string',
'jobStepRestartMarker': {
'fromProcStep': 'string',
'fromStep': 'string',
'skip': True|False,
'stepCheckpoint': 123,
'toProcStep': 'string',
'toStep': 'string'
}
},
's3BatchJobIdentifier': {
'bucket': 'string',
'identifier': {
'fileName': 'string',
'scriptName': 'string'
},
'keyPrefix': 'string'
},
'scriptBatchJobIdentifier': {
'scriptName': 'string'
}
},
jobParams={
'string': 'string'
}
)
string
[REQUIRED]
The unique identifier of the application associated with this batch job.
string
The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.
dict
[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 executionId and JobStepRestartMarker.
executionId (string) -- [REQUIRED]
The executionId from the StartBatchJob response when the job ran for the first time.
jobStepRestartMarker (dict) -- [REQUIRED]
The step/procedure step information for a restart batch job operation.
fromProcStep (string) --
The procedure step name that a batch job was restarted from.
fromStep (string) -- [REQUIRED]
The step name that a batch job was restarted from.
skip (boolean) --
The step-level checkpoint timestamp (creation or last modification) for an Amazon Web Services Blu Age application batch job.
stepCheckpoint (integer) --
Skip selected step and issue a restart from immediate successor step for an Amazon Web Services Blu Age application batch job.
toProcStep (string) --
The procedure step name that a batch job was restarted to.
toStep (string) --
The step name that a batch 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.
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.
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 ...)
For BluAge Engine: There is no limit in length of keys and values. Additional validation may be applied in code, per engine. Parameter key: the first character must be alphabetic. Can be of up to 32 alphanumeric characters.
(string) --
Parameter value can be of up to 1024 alphanumeric characters.
dict
Response Syntax
{
'executionId': 'string'
}
Response Structure
(dict) --
executionId (string) --
The unique identifier of this execution of the batch job.