AWSIoTCreateJobRequest
Objective-C
@interface AWSIoTCreateJobRequest
Swift
class AWSIoTCreateJobRequest
-
Allows you to create criteria to abort a job.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTAbortConfig *_Nullable abortConfig;
Swift
var abortConfig: AWSIoTAbortConfig? { get set }
-
A short text description of the job.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable detail;
Swift
var detail: String? { get set }
-
The job 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 document;
Swift
var document: String? { get set }
-
An S3 link to the job document.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable documentSource;
Swift
var documentSource: String? { get set }
-
Allows you to create a staged rollout of the job.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTJobExecutionsRolloutConfig *_Nullable jobExecutionsRolloutConfig;
Swift
var jobExecutionsRolloutConfig: AWSIoTJobExecutionsRolloutConfig? { get set }
-
A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, “-” and “_” are valid for use here.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable jobId;
Swift
var jobId: String? { get set }
-
The namespace used to indicate that a job is a customer-managed job.
When you specify a value for this parameter, AWS 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 in public preview.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable namespaceId;
Swift
var namespaceId: String? { get set }
-
Configuration information for pre-signed S3 URLs.
Declaration
Objective-C
@property (nonatomic, strong) AWSIoTPresignedUrlConfig *_Nullable presignedUrlConfig;
Swift
var presignedUrlConfig: AWSIoTPresignedUrlConfig? { get set }
-
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 thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
Declaration
Objective-C
@property (nonatomic) AWSIoTTargetSelection targetSelection;
Swift
var targetSelection: AWSIoTTargetSelection { get set }
-
A list of things and thing groups to which the job should be sent.
Declaration
Objective-C
@property (nonatomic, strong) NSArray<NSString *> *_Nullable targets;
Swift
var targets: [String]? { get set }
-
Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set toTIMED_OUT
.Declaration
Objective-C
@property (nonatomic, strong) AWSIoTTimeoutConfig *_Nullable timeoutConfig;
Swift
var timeoutConfig: AWSIoTTimeoutConfig? { get set }