aws_iot_jobtemplate

abort_config

Type: STRUCT
Provider name: abortConfig

• criteria_list
  Type: UNORDERED_LIST_STRUCT
  Provider name: criteriaList
  Description: The list of criteria that determine when and how to abort the job.
  
  • action
    Type: STRING
    Provider name: action
    Description: The type of job action to take to initiate the job abort.
    
  • failure_type
    Type: STRING
    Provider name: failureType
    Description: The type of job execution failures that can initiate a job abort.
    
  • min_number_of_executed_things
    Type: INT32
    Provider name: minNumberOfExecutedThings
    Description: The minimum number of things which must receive job execution notifications before the job can be aborted.
    
  • threshold_percentage
    Type: DOUBLE
    Provider name: thresholdPercentage
    Description: The minimum percentage of job execution failures that must occur to initiate the job abort. Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
    

account_id

Type: STRING

created_at

Type: TIMESTAMP
Provider name: createdAt
Description: The time, in seconds since the epoch, when the job template was created.

description

Type: STRING
Provider name: description
Description: A description of the job template.

destination_package_versions

Type: UNORDERED_LIST_STRING
Provider name: destinationPackageVersions
Description: The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle. Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

document

Type: STRING
Provider name: document
Description: The job document.

document_source

Type: STRING
Provider name: documentSource
Description: An S3 link to the job document.

job_executions_retry_config

Type: STRUCT
Provider name: jobExecutionsRetryConfig
Description: The configuration that determines how many retries are allowed for each failure type for a job.

• criteria_list
  Type: UNORDERED_LIST_STRUCT
  Provider name: criteriaList
  Description: The list of criteria that determines how many retries are allowed for each failure type for a job.
  
  • failure_type
    Type: STRING
    Provider name: failureType
    Description: The type of job execution failures that can initiate a job retry.
    
  • number_of_retries
    Type: INT32
    Provider name: numberOfRetries
    Description: The number of retries allowed for a failure type for the job.
    

job_executions_rollout_config

Type: STRUCT
Provider name: jobExecutionsRolloutConfig

• exponential_rate
  Type: STRUCT
  Provider name: exponentialRate
  Description: The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
  
  • base_rate_per_minute
    Type: INT32
    Provider name: baseRatePerMinute
    Description: The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
    
  • increment_factor
    Type: DOUBLE
    Provider name: incrementFactor
    Description: The exponential factor to increase the rate of rollout for a job. Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).
    
  • rate_increase_criteria
    Type: STRUCT
    Provider name: rateIncreaseCriteria
    Description: The criteria to initiate the increase in rate of rollout for a job.
    
    • number_of_notified_things
      Type: INT32
      Provider name: numberOfNotifiedThings
      Description: The threshold for number of notified things that will initiate the increase in rate of rollout.
      
    • number_of_succeeded_things
      Type: INT32
      Provider name: numberOfSucceededThings
      Description: The threshold for number of succeeded things that will initiate the increase in rate of rollout.
      
• maximum_per_minute
  Type: INT32
  Provider name: maximumPerMinute
  Description: The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
  

job_template_arn

Type: STRING
Provider name: jobTemplateArn
Description: The ARN of the job template.

job_template_id

Type: STRING
Provider name: jobTemplateId
Description: The unique identifier of the job template.

maintenance_windows

Type: UNORDERED_LIST_STRUCT
Provider name: maintenanceWindows
Description: Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

• duration_in_minutes
  Type: INT32
  Provider name: durationInMinutes
  Description: Displays the duration of the next maintenance window.
  
• start_time
  Type: STRING
  Provider name: startTime
  Description: Displays the start time of the next maintenance window.
  

presigned_url_config

Type: STRUCT
Provider name: presignedUrlConfig

• expires_in_sec
  Type: INT64
  Provider name: expiresInSec
  Description: How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
  
• role_arn
  Type: STRING
  Provider name: roleArn
  Description: The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files. For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
  

tags

Type: UNORDERED_LIST_STRING

timeout_config

Type: STRUCT
Provider name: timeoutConfig

• in_progress_timeout_in_minutes
  Type: INT64
  Provider name: inProgressTimeoutInMinutes
  Description: Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can’t be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.