Skip to content

ScheduledTriggerProperties

Source code in docs_src/capo_appflow/types/scheduled_trigger_properties.py
class ScheduledTriggerProperties(TypedDict, closed=True):
    schedule_expression: "capo_appflow.types.schedule_expression.ScheduleExpression"
    """<p> The scheduling expression that determines the rate at which the schedule will run, for example <code>rate(5minutes)</code>. </p>"""
    data_pull_mode: NotRequired["capo_appflow.types.data_pull_mode.DataPullMode"]
    """<p> Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. </p>"""
    schedule_start_time: NotRequired["capo_appflow.types.date.Date"]
    """<p>The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as <code>2022-04-26T13:00:00-07:00</code>.</p>"""
    schedule_end_time: NotRequired["capo_appflow.types.date.Date"]
    """<p>The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as <code>2022-04-27T13:00:00-07:00</code>.</p>"""
    timezone: NotRequired["capo_appflow.types.timezone.Timezone"]
    """<p>Specifies the time zone used when referring to the dates and times of a scheduled flow, such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.</p> <p>If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the <code>America/New_York</code> timezone are <code>-04:00</code> EDT and <code>-05:00 EST</code>.</p>"""
    schedule_offset: NotRequired["capo_appflow.types.schedule_offset.ScheduleOffset"]
    """<p> Specifies the optional offset that is added to the time interval for a schedule-triggered flow. </p>"""
    first_execution_from: NotRequired["capo_appflow.types.date.Date"]
    """<p> Specifies the date range for the records to import from the connector in the first flow run. </p>"""
    flow_error_deactivation_threshold: NotRequired[
        "capo_appflow.types.flow_error_deactivation_threshold.FlowErrorDeactivationThreshold"
    ]
    """<p>Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.</p>"""

data_pull_mode instance-attribute

data_pull_mode: NotRequired[DataPullMode]

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

first_execution_from instance-attribute

first_execution_from: NotRequired[Date]

Specifies the date range for the records to import from the connector in the first flow run.

flow_error_deactivation_threshold instance-attribute

flow_error_deactivation_threshold: NotRequired[FlowErrorDeactivationThreshold]

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

schedule_end_time instance-attribute

schedule_end_time: NotRequired[Date]

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

schedule_expression instance-attribute

schedule_expression: ScheduleExpression

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

schedule_offset instance-attribute

schedule_offset: NotRequired[ScheduleOffset]

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

schedule_start_time instance-attribute

schedule_start_time: NotRequired[Date]

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

timezone instance-attribute

timezone: NotRequired[Timezone]

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.