describe_job_template(**kwargs)¶Displays detailed information about a specified job template. 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.
See also: AWS API Documentation
Request Syntax
response = client.describe_job_template(
id='string'
)
[REQUIRED]
The ID of the job template that will be described.
{
'jobTemplate': {
'name': 'string',
'id': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'createdBy': 'string',
'tags': {
'string': 'string'
},
'jobTemplateData': {
'executionRoleArn': 'string',
'releaseLabel': 'string',
'configurationOverrides': {
'applicationConfiguration': [
{
'classification': 'string',
'properties': {
'string': 'string'
},
'configurations': {'... recursive ...'}
},
],
'monitoringConfiguration': {
'persistentAppUI': 'string',
'cloudWatchMonitoringConfiguration': {
'logGroupName': 'string',
'logStreamNamePrefix': 'string'
},
's3MonitoringConfiguration': {
'logUri': 'string'
}
}
},
'jobDriver': {
'sparkSubmitJobDriver': {
'entryPoint': 'string',
'entryPointArguments': [
'string',
],
'sparkSubmitParameters': 'string'
},
'sparkSqlJobDriver': {
'entryPoint': 'string',
'sparkSqlParameters': 'string'
}
},
'parameterConfiguration': {
'string': {
'type': 'NUMBER'|'STRING',
'defaultValue': 'string'
}
},
'jobTags': {
'string': 'string'
}
},
'kmsKeyArn': 'string',
'decryptionError': 'string'
}
}
Response Structure
This output displays information about the specified job template.
The name of the job template.
The ID of the job template.
The ARN of the job template.
The date and time when the job template was created.
The user who created the job template.
The tags assigned to the job template.
The job template data which holds values of StartJobRun API request.
The execution role ARN of the job run.
The release version of Amazon EMR.
The configuration settings that are used to override defaults configuration.
The configurations for the application running by the job run.
A configuration specification to be used when provisioning virtual clusters, which can include configurations for applications and software bundled with Amazon EMR on EKS. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file.
The classification within a configuration.
A set of properties specified within a configuration classification.
A list of additional configurations to apply within a configuration object.
The configurations for monitoring.
Monitoring configurations for the persistent application UI.
Monitoring configurations for CloudWatch.
The name of the log group for log publishing.
The specified name prefix for log streams.
Amazon S3 configuration for monitoring log publishing.
Amazon S3 destination URI for log publishing.
Specify the driver that the job runs on. Exactly one of the two available job drivers is required, either sparkSqlJobDriver or sparkSubmitJobDriver.
The job driver parameters specified for spark submit.
The entry point of job application.
The arguments for job application.
The Spark submit parameters that are used for job runs.
The job driver for job type.
The SQL file to be executed.
The Spark parameters to be included in the Spark SQL command.
The configuration of parameters existing in the job template.
The configuration of a job template parameter.
The type of the job template parameter. Allowed values are: ‘STRING’, ‘NUMBER’.
The default value for the job template parameter.
The tags assigned to jobs started using the job template.
The KMS key ARN used to encrypt the job template.
The error message in case the decryption of job template fails.
Exceptions
EMRContainers.Client.exceptions.ValidationExceptionEMRContainers.Client.exceptions.ResourceNotFoundExceptionEMRContainers.Client.exceptions.InternalServerException