{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-connect/json-schema/amazon-connect-create-integration-workflow-request-schema.json",
  "title": "CreateIntegrationWorkflowRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-connect-workflows-api-openapi.yml#/components/schemas/CreateIntegrationWorkflowRequest",
  "type": "object",
  "properties": {
    "DomainName": {
      "type": "string",
      "description": "The unique name of the domain."
    },
    "WorkflowType": {
      "type": "string",
      "enum": [
        "APPFLOW_INTEGRATION"
      ],
      "description": "The type of workflow. The only supported value is APPFLOW_INTEGRATION."
    },
    "IntegrationConfig": {
      "$ref": "#/$defs/ProfileIntegrationConfig"
    },
    "ObjectTypeName": {
      "type": "string",
      "description": "The name of the profile object type."
    },
    "RoleArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution."
    },
    "Tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The tags used to organize, track, or control access for this resource."
    }
  },
  "required": [
    "DomainName",
    "WorkflowType",
    "IntegrationConfig",
    "ObjectTypeName",
    "RoleArn"
  ],
  "$defs": {
    "AppflowIntegration": {
      "type": "object",
      "properties": {
        "FlowDefinition": {
          "$ref": "#/$defs/FlowDefinition"
        },
        "Batches": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Batch"
          },
          "description": "Batches in workflow of type APPFLOW_INTEGRATION."
        }
      },
      "required": [
        "FlowDefinition"
      ]
    },
    "Batch": {
      "type": "object",
      "properties": {
        "StartTime": {
          "type": "string",
          "format": "date-time",
          "description": "Start time of batch to split ingestion."
        },
        "EndTime": {
          "type": "string",
          "format": "date-time",
          "description": "End time of batch to split ingestion."
        }
      },
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    "ConnectorOperator": {
      "type": "object",
      "properties": {
        "Marketo": {
          "type": "string",
          "enum": [
            "PROJECTION",
            "LESS_THAN",
            "GREATER_THAN",
            "BETWEEN",
            "ADDITION",
            "MULTIPLICATION",
            "DIVISION",
            "SUBTRACTION",
            "MASK_ALL",
            "MASK_FIRST_N",
            "MASK_LAST_N",
            "VALIDATE_NON_NULL",
            "VALIDATE_NON_ZERO",
            "VALIDATE_NON_NEGATIVE",
            "VALIDATE_NUMERIC",
            "NO_OP"
          ],
          "description": "The operation to be performed on the provided Marketo source fields."
        },
        "S3": {
          "type": "string",
          "enum": [
            "PROJECTION",
            "LESS_THAN",
            "GREATER_THAN",
            "BETWEEN",
            "LESS_THAN_OR_EQUAL_TO",
            "GREATER_THAN_OR_EQUAL_TO",
            "EQUAL_TO",
            "NOT_EQUAL_TO",
            "ADDITION",
            "MULTIPLICATION",
            "DIVISION",
            "SUBTRACTION",
            "MASK_ALL",
            "MASK_FIRST_N",
            "MASK_LAST_N",
            "VALIDATE_NON_NULL",
            "VALIDATE_NON_ZERO",
            "VALIDATE_NON_NEGATIVE",
            "VALIDATE_NUMERIC",
            "NO_OP"
          ],
          "description": "The operation to be performed on the provided Amazon S3 source fields."
        },
        "Salesforce": {
          "type": "string",
          "enum": [
            "PROJECTION",
            "LESS_THAN",
            "CONTAINS",
            "GREATER_THAN",
            "BETWEEN",
            "LESS_THAN_OR_EQUAL_TO",
            "GREATER_THAN_OR_EQUAL_TO",
            "EQUAL_TO",
            "NOT_EQUAL_TO",
            "ADDITION",
            "MULTIPLICATION",
            "DIVISION",
            "SUBTRACTION",
            "MASK_ALL",
            "MASK_FIRST_N",
            "MASK_LAST_N",
            "VALIDATE_NON_NULL",
            "VALIDATE_NON_ZERO",
            "VALIDATE_NON_NEGATIVE",
            "VALIDATE_NUMERIC",
            "NO_OP"
          ],
          "description": "The operation to be performed on the provided Salesforce source fields."
        },
        "ServiceNow": {
          "type": "string",
          "enum": [
            "PROJECTION",
            "CONTAINS",
            "LESS_THAN",
            "GREATER_THAN",
            "BETWEEN",
            "LESS_THAN_OR_EQUAL_TO",
            "GREATER_THAN_OR_EQUAL_TO",
            "EQUAL_TO",
            "NOT_EQUAL_TO",
            "ADDITION",
            "MULTIPLICATION",
            "DIVISION",
            "SUBTRACTION",
            "MASK_ALL",
            "MASK_FIRST_N",
            "MASK_LAST_N",
            "VALIDATE_NON_NULL",
            "VALIDATE_NON_ZERO",
            "VALIDATE_NON_NEGATIVE",
            "VALIDATE_NUMERIC",
            "NO_OP"
          ],
          "description": "The operation to be performed on the provided ServiceNow source fields."
        },
        "Zendesk": {
          "type": "string",
          "enum": [
            "PROJECTION",
            "GREATER_THAN",
            "ADDITION",
            "MULTIPLICATION",
            "DIVISION",
            "SUBTRACTION",
            "MASK_ALL",
            "MASK_FIRST_N",
            "MASK_LAST_N",
            "VALIDATE_NON_NULL",
            "VALIDATE_NON_ZERO",
            "VALIDATE_NON_NEGATIVE",
            "VALIDATE_NUMERIC",
            "NO_OP"
          ],
          "description": "The operation to be performed on the provided Zendesk source fields."
        }
      }
    },
    "FlowDefinition": {
      "type": "object",
      "properties": {
        "Description": {
          "type": "string",
          "description": "A description of the flow you want to create."
        },
        "FlowName": {
          "type": "string",
          "description": "The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed."
        },
        "KmsArn": {
          "type": "string",
          "description": "The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption."
        },
        "SourceFlowConfig": {
          "$ref": "#/$defs/SourceFlowConfig"
        },
        "Tasks": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Task"
          },
          "description": "A list of tasks that Customer Profiles performs while transferring the data in the flow run."
        },
        "TriggerConfig": {
          "$ref": "#/$defs/TriggerConfig"
        }
      },
      "required": [
        "FlowName",
        "KmsArn",
        "SourceFlowConfig",
        "Tasks",
        "TriggerConfig"
      ]
    },
    "IncrementalPullConfig": {
      "type": "object",
      "properties": {
        "DatetimeTypeFieldName": {
          "type": "string",
          "description": "A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source."
        }
      }
    },
    "MarketoSourceProperties": {
      "type": "object",
      "properties": {
        "Object": {
          "type": "string",
          "description": "The object specified in the Marketo flow source."
        }
      },
      "required": [
        "Object"
      ]
    },
    "ProfileIntegrationConfig": {
      "type": "object",
      "properties": {
        "AppflowIntegration": {
          "$ref": "#/$defs/AppflowIntegration"
        }
      }
    },
    "S3SourceProperties": {
      "type": "object",
      "properties": {
        "BucketName": {
          "type": "string",
          "description": "The Amazon S3 bucket name where the source files are stored."
        },
        "BucketPrefix": {
          "type": "string",
          "description": "The object key for the Amazon S3 bucket in which the source files are stored."
        }
      },
      "required": [
        "BucketName"
      ]
    },
    "SalesforceSourceProperties": {
      "type": "object",
      "properties": {
        "Object": {
          "type": "string",
          "description": "The object specified in the Salesforce flow source."
        },
        "EnableDynamicFieldUpdate": {
          "type": "boolean",
          "description": "The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow."
        },
        "IncludeDeletedRecords": {
          "type": "boolean",
          "description": "Indicates whether Amazon AppFlow includes deleted files in the flow run."
        }
      },
      "required": [
        "Object"
      ]
    },
    "ScheduledTriggerProperties": {
      "type": "object",
      "properties": {
        "ScheduleExpression": {
          "type": "string",
          "description": "The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes)."
        },
        "DataPullMode": {
          "type": "string",
          "enum": [
            "Incremental",
            "Complete"
          ],
          "description": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run."
        },
        "ScheduleStartTime": {
          "type": "string",
          "format": "date-time",
          "description": "Specifies the scheduled start time for a scheduled-trigger flow."
        },
        "ScheduleEndTime": {
          "type": "string",
          "format": "date-time",
          "description": "Specifies the scheduled end time for a scheduled-trigger flow."
        },
        "Timezone": {
          "type": "string",
          "description": "Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York."
        },
        "ScheduleOffset": {
          "type": "integer",
          "description": "Specifies the optional offset that is added to the time interval for a schedule-triggered flow."
        },
        "FirstExecutionFrom": {
          "type": "string",
          "format": "date-time",
          "description": "Specifies the date range for the records to import from the connector in the first flow run."
        }
      },
      "required": [
        "ScheduleExpression"
      ]
    },
    "ServiceNowSourceProperties": {
      "type": "object",
      "properties": {
        "Object": {
          "type": "string",
          "description": "The object specified in the ServiceNow flow source."
        }
      },
      "required": [
        "Object"
      ]
    },
    "SourceConnectorProperties": {
      "type": "object",
      "properties": {
        "Marketo": {
          "$ref": "#/$defs/MarketoSourceProperties"
        },
        "S3": {
          "$ref": "#/$defs/S3SourceProperties"
        },
        "Salesforce": {
          "$ref": "#/$defs/SalesforceSourceProperties"
        },
        "ServiceNow": {
          "$ref": "#/$defs/ServiceNowSourceProperties"
        },
        "Zendesk": {
          "$ref": "#/$defs/ZendeskSourceProperties"
        }
      }
    },
    "SourceFlowConfig": {
      "type": "object",
      "properties": {
        "ConnectorProfileName": {
          "type": "string",
          "description": "The name of the AppFlow connector profile. This name must be unique for each connector profile in the AWS account."
        },
        "ConnectorType": {
          "type": "string",
          "enum": [
            "Salesforce",
            "Marketo",
            "Zendesk",
            "Servicenow",
            "S3"
          ],
          "description": "The type of connector, such as Salesforce, Marketo, and so on."
        },
        "IncrementalPullConfig": {
          "$ref": "#/$defs/IncrementalPullConfig"
        },
        "SourceConnectorProperties": {
          "$ref": "#/$defs/SourceConnectorProperties"
        }
      },
      "required": [
        "ConnectorType",
        "SourceConnectorProperties"
      ]
    },
    "Task": {
      "type": "object",
      "properties": {
        "ConnectorOperator": {
          "$ref": "#/$defs/ConnectorOperator"
        },
        "DestinationField": {
          "type": "string",
          "description": "A field in a destination connector, or a field value against which Amazon AppFlow validates a source field."
        },
        "SourceFields": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The source fields to which a particular task is applied."
        },
        "TaskProperties": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "A map used to store task-related information. The service looks for particular information based on the TaskType."
        },
        "TaskType": {
          "type": "string",
          "enum": [
            "Arithmetic",
            "Filter",
            "Map",
            "Mask",
            "Merge",
            "Truncate",
            "Validate"
          ],
          "description": "Specifies the particular task implementation that Amazon AppFlow performs."
        }
      },
      "required": [
        "SourceFields",
        "TaskType"
      ]
    },
    "TriggerConfig": {
      "type": "object",
      "properties": {
        "TriggerType": {
          "type": "string",
          "enum": [
            "Scheduled",
            "Event",
            "OnDemand"
          ],
          "description": "Specifies the type of flow trigger. It can be OnDemand, Scheduled, or Event."
        },
        "TriggerProperties": {
          "$ref": "#/$defs/TriggerProperties"
        }
      },
      "required": [
        "TriggerType"
      ]
    },
    "TriggerProperties": {
      "type": "object",
      "properties": {
        "Scheduled": {
          "$ref": "#/$defs/ScheduledTriggerProperties"
        }
      }
    },
    "ZendeskSourceProperties": {
      "type": "object",
      "properties": {
        "Object": {
          "type": "string",
          "description": "The object specified in the Zendesk flow source."
        }
      },
      "required": [
        "Object"
      ]
    }
  }
}