AWS::IoT::Job

IoT Job

Use the AWS::IoT::Job resource to declare an AWS IoT job. A job can be used to define a set of remote operations that are sent to and run on one or more devices (things or thing groups) connected to AWS IoT.

Properties

16 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
JobId
string
RequiredCreate-only
Targets
Array<string>
RequiredCreate-only
AbortConfig
AbortConfig
Description
string
DestinationPackageVersions
Array<string>
Create-only
Document
string
Create-onlyWrite-only
DocumentParameters
object
Create-only
DocumentSource
string
Create-only
JobExecutionsRetryConfig
JobExecutionsRetryConfig
Create-only
JobExecutionsRolloutConfig
JobExecutionsRolloutConfig
JobTemplateArn
string
Create-only
PresignedUrlConfig
PresignedUrlConfig
SchedulingConfig
SchedulingConfig
Create-only
Tags
Array<Tag>
TargetSelection
string
Create-only
TimeoutConfig
TimeoutConfig

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ArnstringThe Amazon Resource Name (ARN) of the job.
CreatedAtstringThe time when the job was created, in ISO 8601 date-time format.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoT::Job

Resources:
  MyResource:
    Type: AWS::IoT::Job
    Properties:
      JobId: "my-jobid"
      Targets: []
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iot:CreateJobiot:DescribeJobiot:TagResourceiot:ListTagsForResourceiot:GetPackageVersioniam:PassRoles3:GetObject

read

iot:DescribeJobiot:ListTagsForResource

update

iot:UpdateJobiot:DescribeJobiot:TagResourceiot:UntagResourceiot:ListTagsForResourceiam:PassRole

delete

iot:DeleteJobiot:DescribeJob

list

iot:ListJobs

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoT
Properties18
Required2
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

JobIdTargetsDocumentDocumentSourceTargetSelectionJobTemplateArnDocumentParametersSchedulingConfigDestinationPackageVersionsJobExecutionsRetryConfig

Related Resources

External Links