AWSIoTCreateJobRequest

Objective-C

@interface AWSIoTCreateJobRequest

Swift

class AWSIoTCreateJobRequest

  • Allows you to create the 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 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable destinationPackageVersions;

    Swift

    var destinationPackageVersions: [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 }

  • Parameters of an Amazon Web Services managed template that you can specify to create the job document.

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable documentParameters;

    Swift

    var documentParameters: [String : String]? { get set }

  • An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don’t specify a value for document.

    For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

    For more information, see Methods for accessing a bucket.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable documentSource;

    Swift

    var documentSource: 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 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 Amazon Web Services 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 ARN of the job template used to create the job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobTemplateArn;

    Swift

    var jobTemplateArn: String? { get set }

  • 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.

    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 }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTSchedulingConfig *_Nullable schedulingConfig;

    Swift

    var schedulingConfig: AWSIoTSchedulingConfig? { get set }

  • Metadata which can be used to manage the job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTTag *> *_Nullable tags;

    Swift

    var tags: [AWSIoTTag]? { 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.

    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.

    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 to TIMED_OUT.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTTimeoutConfig *_Nullable timeoutConfig;

    Swift

    var timeoutConfig: AWSIoTTimeoutConfig? { get set }