ScheduledTriggerProperties
Specifies the configuration details of a schedule-triggered flow as defined by the
user. Currently, these settings only apply to the Scheduled
trigger type.
Contents
- dataPullMode
-
Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Type: String
Valid Values:
Incremental | Complete
Required: No
- firstExecutionFrom
-
Specifies the date range for the records to import from the connector in the first flow run.
Type: Timestamp
Required: No
- scheduleEndTime
-
Specifies the scheduled end time for a schedule-triggered flow.
Type: Timestamp
Required: No
- scheduleExpression
-
The scheduling expression that determines the rate at which the schedule will run, for example
rate(5minutes)
.Type: String
Length Constraints: Maximum length of 256.
Pattern:
.*
Required: Yes
- scheduleOffset
-
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 36000.
Required: No
- scheduleStartTime
-
Specifies the scheduled start time for a schedule-triggered flow.
Type: Timestamp
Required: No
- timezone
-
Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as
America/New_York
.Type: String
Length Constraints: Maximum length of 256.
Pattern:
.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: