batch_job_executions

Creates, updates, deletes, gets or lists a batch_job_executions resource.

Overview

Name	batch_job_executions
Type	Resource
Id	aws.m2.batch_job_executions

Fields

The following fields are returned by SELECT queries:

get_batch_job_execution

Name	Datatype	Description
application_id	string	The identifier of the application. (pattern: <code>^\S{1,80}$</code>)
batch_job_identifier	object	The unique identifier of this batch job.
end_time	string (date-time)	The timestamp when the batch job execution ended.
execution_id	string	The unique identifier for this batch job execution. (pattern: <code>^\S{1,80}$</code>)
job_id	string	The unique identifier for this batch job. (pattern: <code>^\S{1,100}$</code>)
job_name	string	The name of this batch job. (pattern: <code>^\S{1,100}$</code>)
job_step_restart_marker	object	The step/procedure step information for the restart batch job operation.
job_type	string	The type of job. (VSE, JES2, JES3)
job_user	string	The user for the job. (pattern: <code>^\S{1,100}$</code>)
return_code	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.
start_time	string (date-time)	The timestamp when the batch job execution started.
status	string	The status of the batch job execution. (Submitting, Holding, Dispatching, Running, Cancelling, Cancelled, Succeeded, Failed, Purged, Succeeded With Warning)
status_reason	string	The reason for the reported status.

list_batch_job_executions

Name	Datatype	Description
application_id	string	The unique identifier of the application that hosts this batch job. (pattern: <code>^\S{1,80}$</code>)
batch_job_identifier	object	The unique identifier of this batch job.
end_time	string (date-time)	The timestamp when this batch job execution ended.
execution_id	string	The unique identifier of this execution of the batch job. (pattern: <code>^\S{1,80}$</code>)
job_id	string	The unique identifier of a particular batch job. (pattern: <code>^\S{1,100}$</code>)
job_name	string	The name of a particular batch job. (pattern: <code>^\S{1,100}$</code>)
job_type	string	The type of a particular batch job execution. (VSE, JES2, JES3)
return_code	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.
start_time	string (date-time)	The timestamp when a particular batch job execution started.
status	string	The status of a particular batch job execution. (Submitting, Holding, Dispatching, Running, Cancelling, Cancelled, Succeeded, Failed, Purged, Succeeded With Warning)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_batch_job_execution	select	application_id, execution_id, region		Gets the details of a specific batch job execution for a specific application.
list_batch_job_executions	select	application_id, region	executionIds, jobName, maxResults, nextToken, startedAfter, startedBefore, status	Lists historical, current, and scheduled batch job executions for a specific application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The unique identifier of the application.
execution_id	string	The unique identifier of the batch job execution.
region	string	AWS region (default: us-east-1)
executionIds	array	The unique identifier of each batch job execution.
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	string (date-time)	The time after which the batch job executions started.
startedBefore	string (date-time)	The time before the batch job executions started.
status	string	The status of the batch job executions.

SELECT examples

get_batch_job_execution

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

SELECT
application_id,
batch_job_identifier,
end_time,
execution_id,
job_id,
job_name,
job_step_restart_marker,
job_type,
job_user,
return_code,
start_time,
status,
status_reason
FROM aws.m2.batch_job_executions
WHERE application_id = '{{ application_id }}' -- required
AND execution_id = '{{ execution_id }}' -- required
AND region = '{{ region }}' -- required
;

list_batch_job_executions

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

SELECT
application_id,
batch_job_identifier,
end_time,
execution_id,
job_id,
job_name,
job_type,
return_code,
start_time,
status
FROM aws.m2.batch_job_executions
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND executionIds = '{{ executionIds }}'
AND jobName = '{{ jobName }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND startedAfter = '{{ startedAfter }}'
AND startedBefore = '{{ startedBefore }}'
AND status = '{{ status }}'
;