Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListJobTemplates

Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

Request Syntax


GET /jobtemplates?createdAfter=createdAfter&createdBefore=createdBefore&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

createdAfter

The date and time after which the job templates were created.

createdBefore

The date and time before which the job templates were created.

maxResults

The maximum number of job templates that can be listed.

nextToken

The token for the next set of job templates to return.

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "templates": [ 
      { 
         "arn": "string",
         "createdAt": "string",
         "createdBy": "string",
         "decryptionError": "string",
         "id": "string",
         "jobTemplateData": { 
            "configurationOverrides": { 
               "applicationConfiguration": [ 
                  { 
                     "classification": "string",
                     "configurations": [ 
                        "Configuration"
                     ],
                     "properties": { 
                        "string" : "string" 
                     }
                  }
               ],
               "monitoringConfiguration": { 
                  "cloudWatchMonitoringConfiguration": { 
                     "logGroupName": "string",
                     "logStreamNamePrefix": "string"
                  },
                  "persistentAppUI": "string",
                  "s3MonitoringConfiguration": { 
                     "logUri": "string"
                  }
               }
            },
            "executionRoleArn": "string",
            "jobDriver": { 
               "sparkSqlJobDriver": { 
                  "entryPoint": "string",
                  "sparkSqlParameters": "string"
               },
               "sparkSubmitJobDriver": { 
                  "entryPoint": "string",
                  "entryPointArguments": [ "string" ],
                  "sparkSubmitParameters": "string"
               }
            },
            "jobTags": { 
               "string" : "string" 
            },
            "parameterConfiguration": { 
               "string" : { 
                  "defaultValue": "string",
                  "type": "string"
               }
            },
            "releaseLabel": "string"
         },
         "kmsKeyArn": "string",
         "name": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

This output displays the token for the next set of job templates.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

templates

This output lists information about the specified job templates.

Type: Array of JobTemplate objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

This is an internal server exception.

HTTP Status Code: 500

ValidationException

There are invalid parameters in the client request.

HTTP Status Code: 400