AWSIoTDocumentParameter

Objective-C

@interface AWSIoTDocumentParameter

Swift

class AWSIoTDocumentParameter

A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

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.

  • Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

    Declaration

    Objective-C

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

    Swift

    var detail: String? { get set }

  • An example illustrating a pattern that need to be replaced in a managed template job document schema.

    Declaration

    Objective-C

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

    Swift

    var example: String? { get set }
  • key

    Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

    Declaration

    Objective-C

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

    Swift

    var key: String? { get set }

  • Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable optionalValue;

    Swift

    var optionalValue: NSNumber? { get set }

  • A regular expression of the patterns that need to be replaced in a managed template job document schema.

    Declaration

    Objective-C

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

    Swift

    var regex: String? { get set }