Amazon AppFlow · JSON Structure

Appflow Cancel Flow Executions Request Structure

CancelFlowExecutionsRequest schema from Amazon AppFlow API

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

Appflow Cancel Flow Executions Request Structure is a JSON Structure definition published by Amazon AppFlow, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

flowName executionIds

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

JSON Structure

Raw ↑ 
{
  "type": "object",
  "description": "CancelFlowExecutionsRequest schema from Amazon AppFlow API",
  "properties": {
    "flowName": {
      "type": "string",
      "description": "The name of a flow with active runs that you want to cancel.",
      "maxLength": 256,
      "example": "my-salesforce-to-s3-flow"
    },
    "executionIds": {
      "type": "array",
      "description": "The ID of each active run to cancel. If you omit this parameter, your request ends all active runs that belong to the flow.",
      "items": {
        "type": "string",
        "example": ""
      },
      "example": [
        "exec-500123"
      ]
    }
  },
  "required": [
    "flowName"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-appflow/refs/heads/main/json-structure/appflow-cancel-flow-executions-request-structure.json"
}