batch_job_definitions

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

Overview

Name	batch_job_definitions
Type	Resource
Id	aws.m2.batch_job_definitions

Fields

The following fields are returned by SELECT queries:

list_batch_job_definitions

Name	Datatype	Description
file_batch_job_definition	object	Specifies a file containing a batch job definition.
script_batch_job_definition	object	A script containing a batch job definition.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_batch_job_definitions	select	application_id, region	maxResults, nextToken, prefix	Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.

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 identifier of the application.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of batch job definitions to return.
nextToken	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.
prefix	string	If the batch job definition is a FileBatchJobDefinition, the prefix allows you to search on the file names of FileBatchJobDefinitions.

SELECT examples

list_batch_job_definitions

Lists all the available batch job definitions based on the batch job resources uploaded during the application creation. You can use the batch job definitions in the list to start a batch job.

SELECT
file_batch_job_definition,
script_batch_job_definition
FROM aws.m2.batch_job_definitions
WHERE application_id = '{{ application_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND prefix = '{{ prefix }}'
;