aws_iot_job

account_id

Type: STRING

document_source

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

job

Type: STRUCT
Provider name: job
Description: Information about the job.

• abort_config
  Type: STRUCT
  Provider name: abortConfig
  Description: Configuration for criteria to abort the job.
  
  • 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).
      
• comment
  Type: STRING
  Provider name: comment
  Description: If the job was updated, describes the reason for the update.
  
• completed_at
  Type: TIMESTAMP
  Provider name: completedAt
  Description: The time, in seconds since the epoch, when the job was completed.
  
• created_at
  Type: TIMESTAMP
  Provider name: createdAt
  Description: The time, in seconds since the epoch, when the job was created.
  
• description
  Type: STRING
  Provider name: description
  Description: A short text description of the job.
  
• 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.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_parameters
  Type: MAP_STRING_STRING
  Provider name: documentParameters
  Description: A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job. documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can’t be used with custom job templates or to create jobs from them.
  
• force_canceled
  Type: BOOLEAN
  Provider name: forceCanceled
  Description: Will be true if the job was canceled with the optional force parameter set to true.
  
• is_concurrent
  Type: BOOLEAN
  Provider name: isConcurrent
  Description: Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.
  
• job_arn
  Type: STRING
  Provider name: jobArn
  Description: An ARN identifying the job with format “arn:aws:iot:region:account:job/jobId”.
  
• job_executions_retry_config
  Type: STRUCT
  Provider name: jobExecutionsRetryConfig
  Description: The configuration for the criteria to retry the 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
  Description: Allows you to create a staged rollout of a job.
  
  • 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_id
  Type: STRING
  Provider name: jobId
  Description: The unique identifier you assigned to this job when it was created.
  
• job_process_details
  Type: STRUCT
  Provider name: jobProcessDetails
  Description: Details about the job process.
  
  • number_of_canceled_things
    Type: INT32
    Provider name: numberOfCanceledThings
    Description: The number of things that cancelled the job.
    
  • number_of_failed_things
    Type: INT32
    Provider name: numberOfFailedThings
    Description: The number of things that failed executing the job.
    
  • number_of_in_progress_things
    Type: INT32
    Provider name: numberOfInProgressThings
    Description: The number of things currently executing the job.
    
  • number_of_queued_things
    Type: INT32
    Provider name: numberOfQueuedThings
    Description: The number of things that are awaiting execution of the job.
    
  • number_of_rejected_things
    Type: INT32
    Provider name: numberOfRejectedThings
    Description: The number of things that rejected the job.
    
  • number_of_removed_things
    Type: INT32
    Provider name: numberOfRemovedThings
    Description: The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
    
  • number_of_succeeded_things
    Type: INT32
    Provider name: numberOfSucceededThings
    Description: The number of things which successfully completed the job.
    
  • number_of_timed_out_things
    Type: INT32
    Provider name: numberOfTimedOutThings
    Description: The number of things whose job execution status is TIMED_OUT.
    
  • processing_targets
    Type: UNORDERED_LIST_STRING
    Provider name: processingTargets
    Description: The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
    
• job_template_arn
  Type: STRING
  Provider name: jobTemplateArn
  Description: The ARN of the job template used to create the job.
  
• last_updated_at
  Type: TIMESTAMP
  Provider name: lastUpdatedAt
  Description: The time, in seconds since the epoch, when the job was last updated.
  
• namespace_id
  Type: STRING
  Provider name: namespaceId
  Description: The namespace used to indicate that a job is a customer-managed job. When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format. $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/ The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
  
• presigned_url_config
  Type: STRUCT
  Provider name: presignedUrlConfig
  Description: Configuration for pre-signed S3 URLs.
  
  • 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.
    
• reason_code
  Type: STRING
  Provider name: reasonCode
  Description: If the job was updated, provides the reason code for the update.
  
• scheduled_job_rollouts
  Type: UNORDERED_LIST_STRUCT
  Provider name: scheduledJobRollouts
  Description: Displays the next seven maintenance window occurrences and their start times.
  
  • start_time
    Type: STRING
    Provider name: startTime
    Description: Displays the start times of the next seven maintenance window occurrences.
    
• scheduling_config
  Type: STRUCT
  Provider name: schedulingConfig
  Description: The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.
  
  • end_behavior
    Type: STRING
    Provider name: endBehavior
    Description: Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
    
  • end_time
    Type: STRING
    Provider name: endTime
    Description: The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time. For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.
    
  • maintenance_windows
    Type: UNORDERED_LIST_STRUCT
    Provider name: maintenanceWindows
    Description: An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a 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.
      
  • start_time
    Type: STRING
    Provider name: startTime
    Description: The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time. For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.
    
• status
  Type: STRING
  Provider name: status
  Description: The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
  
• target_selection
  Type: STRING
  Provider name: targetSelection
  Description: Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group. We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
  
• targets
  Type: UNORDERED_LIST_STRING
  Provider name: targets
  Description: A list of IoT things and thing groups to which the job should be sent.
  
• timeout_config
  Type: STRUCT
  Provider name: timeoutConfig
  Description: 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 to TIMED_OUT.
  
  • 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.
    

tags

Type: UNORDERED_LIST_STRING