AWSIoTCreateJobTemplateRequest
Objective-C
@interface AWSIoTCreateJobTemplateRequest
Swift
class AWSIoTCreateJobTemplateRequest
-
The criteria that determine when and how a job abort takes place.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTAbortConfig *_Nullable abortConfig;
Swift
var abortConfig: AWSIoTAbortConfig? { get set }
-
A description of the job document.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable detail;
Swift
var detail: String? { get set }
-
The job document. Required if you don’t specify a value for
documentSource
.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable document;
Swift
var document: String? { get set }
-
An S3 link to the job document to use in the template. Required if you don’t specify a value for
document
.If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
The placeholder link is of the following form:
${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
where bucket is your bucket name and key is the object in the bucket to which you are linking.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable documentSource;
Swift
var documentSource: String? { get set }
-
The ARN of the job to use as the basis for the job template.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable jobArn;
Swift
var jobArn: String? { get set }
-
Allows you to create the criteria to retry a job.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTJobExecutionsRetryConfig *_Nullable jobExecutionsRetryConfig;
Swift
var jobExecutionsRetryConfig: AWSIoTJobExecutionsRetryConfig? { get set }
-
Allows you to create a staged rollout of a job.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTJobExecutionsRolloutConfig *_Nullable jobExecutionsRolloutConfig;
Swift
var jobExecutionsRolloutConfig: AWSIoTJobExecutionsRolloutConfig? { get set }
-
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, “-”, and “_” are valid for use here.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable jobTemplateId;
Swift
var jobTemplateId: String? { get set }
-
Configuration for pre-signed S3 URLs.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTPresignedUrlConfig *_Nullable presignedUrlConfig;
Swift
var presignedUrlConfig: AWSIoTPresignedUrlConfig? { get set }
-
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
.Declaration
Objective-C
@property (nonatomic, strong) AWSIoTTimeoutConfig *_Nullable timeoutConfig;
Swift
var timeoutConfig: AWSIoTTimeoutConfig? { get set }