DescribeJobTemplate
Returns information about a job template.
Request Syntax
GET /job-templates/jobTemplateId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- jobTemplateId
-
The unique identifier of the job template.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"abortConfig": {
"criteriaList": [
{
"action": "string",
"failureType": "string",
"minNumberOfExecutedThings": number,
"thresholdPercentage": number
}
]
},
"createdAt": number,
"description": "string",
"document": "string",
"documentSource": "string",
"jobExecutionsRetryConfig": {
"criteriaList": [
{
"failureType": "string",
"numberOfRetries": number
}
]
},
"jobExecutionsRolloutConfig": {
"exponentialRate": {
"baseRatePerMinute": number,
"incrementFactor": number,
"rateIncreaseCriteria": {
"numberOfNotifiedThings": number,
"numberOfSucceededThings": number
}
},
"maximumPerMinute": number
},
"jobTemplateArn": "string",
"jobTemplateId": "string",
"presignedUrlConfig": {
"expiresInSec": number,
"roleArn": "string"
},
"timeoutConfig": {
"inProgressTimeoutInMinutes": number
}
}
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.
- abortConfig
-
The criteria that determine when and how a job abort takes place.
Type: AbortConfig object
- createdAt
-
The time, in seconds since the epoch, when the job template was created.
Type: Timestamp
- description
-
A description of the job template.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]+
- document
-
The job document.
Type: String
Length Constraints: Maximum length of 32768.
- documentSource
-
An S3 link to the job document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1350.
- jobExecutionsRetryConfig
-
The configuration that determines how many retries are allowed for each failure type for a job.
Type: JobExecutionsRetryConfig object
- jobExecutionsRolloutConfig
-
Allows you to create a staged rollout of a job.
Type: JobExecutionsRolloutConfig object
- jobTemplateArn
-
The ARN of the job template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern:
^arn:[!-~]+$
- jobTemplateId
-
The unique identifier of the job template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+
- presignedUrlConfig
-
Configuration for pre-signed S3 URLs.
Type: PresignedUrlConfig object
- timeoutConfig
-
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to
IN_PROGRESS
. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set toTIMED_OUT
.Type: TimeoutConfig object
Errors
- InternalFailureException
-
An unexpected error has occurred.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: