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 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 }

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

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

  • Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTMaintenanceWindow *> *_Nullable maintenanceWindows;

    Swift

    var maintenanceWindows: [AWSIoTMaintenanceWindow]? { get set }

  • Configuration for pre-signed S3 URLs.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTPresignedUrlConfig *_Nullable presignedUrlConfig;

    Swift

    var presignedUrlConfig: AWSIoTPresignedUrlConfig? { get set }

  • Metadata that can be used to manage the job template.

    Declaration

    Objective-C

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

    Swift

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

    Declaration

    Objective-C

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

    Swift

    var timeoutConfig: AWSIoTTimeoutConfig? { get set }