Amazon AppFlow · JSON Structure

Appflow Scheduled Trigger Properties Structure

ScheduledTriggerProperties schema from Amazon AppFlow API

Type: object Properties: 8 Required: 1
ConnectorsData FlowData IntegrationETLIntegrationSaaSData Transfer

Appflow Scheduled Trigger Properties Structure is a JSON Structure definition published by Amazon AppFlow, describing 8 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

scheduleExpression dataPullMode scheduleStartTime scheduleEndTime timezone scheduleOffset firstExecutionFrom flowErrorDeactivationThreshold

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "ScheduledTriggerProperties schema from Amazon AppFlow API",
  "properties": {
    "scheduleExpression": {
      "type": "string",
      "description": "The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).",
      "example": "rate(1day)"
    },
    "dataPullMode": {
      "type": "string",
      "description": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.",
      "enum": [
        "Incremental",
        "Complete"
      ],
      "example": "Incremental"
    },
    "scheduleStartTime": {
      "type": "int64",
      "description": "The time at which the scheduled flow starts.",
      "example": 1718153645993
    },
    "scheduleEndTime": {
      "type": "int64",
      "description": "The time at which the scheduled flow ends.",
      "example": 1718153645993
    },
    "timezone": {
      "type": "string",
      "description": "Specifies the time zone used when referring to the date and time of a scheduled-triggered flow.",
      "example": "America/New_York"
    },
    "scheduleOffset": {
      "type": "int64",
      "description": "Specifies the optional offset that is added to the time interval for a schedule-triggered flow.",
      "example": 0
    },
    "firstExecutionFrom": {
      "type": "int64",
      "description": "Specifies the date range for the records to import from the connector in the first flow run.",
      "example": 1718153645993
    },
    "flowErrorDeactivationThreshold": {
      "type": "int32",
      "description": "Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.",
      "example": 3
    }
  },
  "required": [
    "scheduleExpression"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-appflow/refs/heads/main/json-structure/appflow-scheduled-trigger-properties-structure.json"
}