Amazon AppFlow Flows API

openapi: 3.1.0
info:
  title: Amazon AppFlow Connectors Flows API
  description: Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between SaaS applications like Salesforce, SAP, Zendesk, Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift. You can run data flows at enterprise scale at the frequency you choose — on a schedule, in response to a business event, or on demand.
  version: '2020-08-23'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: https://appflow.{region}.amazonaws.com
  description: Amazon AppFlow regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- sigv4: []
tags:
- name: Flows
  description: Operations for creating and managing data flows
paths:
  /create-flow:
    post:
      operationId: createFlow
      summary: Amazon AppFlow Create Flow
      description: Creates a new flow for transferring data between a source connector and a destination connector.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFlowRequest'
            examples:
              CreateFlowRequestExample:
                summary: Default createFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
                  description: Transfer Salesforce accounts to S3 daily
                  triggerConfig:
                    triggerType: Scheduled
                    triggerProperties:
                      Scheduled:
                        scheduleExpression: rate(1day)
                  sourceFlowConfig:
                    connectorType: Salesforce
                    connectorProfileName: my-salesforce-profile
                    sourceConnectorProperties:
                      Salesforce:
                        object: Account
                  destinationFlowConfigList:
                  - connectorType: S3
                    destinationConnectorProperties:
                      S3:
                        bucketName: my-data-bucket
                        bucketPrefix: appflow/salesforce/accounts
                  tasks:
                  - taskType: Map
                    sourceFields:
                    - Id
                    destinationField: Id
                    taskProperties: {}
      responses:
        '200':
          description: Flow created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFlowResponse'
              examples:
                CreateFlow200Example:
                  summary: Default createFlow 200 response
                  x-microcks-default: true
                  value:
                    flowArn: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
                    flowStatus: Active
        '400':
          description: Validation error or connector server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Connector authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Service quota exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — flow with this name already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /delete-flow:
    post:
      operationId: deleteFlow
      summary: Amazon AppFlow Delete Flow
      description: Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFlowRequest'
            examples:
              DeleteFlowRequestExample:
                summary: Default deleteFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
                  forceDelete: false
      responses:
        '200':
          description: Flow deleted successfully
          content:
            application/json:
              schema:
                type: object
              examples:
                DeleteFlow200Example:
                  summary: Default deleteFlow 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — flow is running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /describe-flow:
    post:
      operationId: describeFlow
      summary: Amazon AppFlow Describe Flow
      description: Provides a description of the specified flow.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFlowRequest'
            examples:
              DescribeFlowRequestExample:
                summary: Default describeFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
      responses:
        '200':
          description: Flow description returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFlowResponse'
              examples:
                DescribeFlow200Example:
                  summary: Default describeFlow 200 response
                  x-microcks-default: true
                  value:
                    flowArn: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
                    flowName: my-salesforce-to-s3-flow
                    description: Transfer Salesforce accounts to S3 daily
                    flowStatus: Active
                    sourceFlowConfig:
                      connectorType: Salesforce
                      connectorProfileName: my-salesforce-profile
                      sourceConnectorProperties:
                        Salesforce:
                          object: Account
                    triggerConfig:
                      triggerType: Scheduled
                    createdAt: 1718153645993
                    lastUpdatedAt: 1718153645993
                    createdBy: arn:aws:iam::123456789012:user/admin
                    lastUpdatedBy: arn:aws:iam::123456789012:user/admin
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /list-flows:
    post:
      operationId: listFlows
      summary: Amazon AppFlow List Flows
      description: Lists all of the flows associated with your account.
      tags:
      - Flows
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFlowsRequest'
            examples:
              ListFlowsRequestExample:
                summary: Default listFlows request
                x-microcks-default: true
                value:
                  maxResults: 20
      responses:
        '200':
          description: List of flows returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFlowsResponse'
              examples:
                ListFlows200Example:
                  summary: Default listFlows 200 response
                  x-microcks-default: true
                  value:
                    flows:
                    - flowArn: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
                      flowName: my-salesforce-to-s3-flow
                      description: Transfer Salesforce accounts to S3 daily
                      flowStatus: Active
                      sourceConnectorType: Salesforce
                      destinationConnectorType: S3
                      triggerType: Scheduled
                      createdAt: 1718153645993
                      lastUpdatedAt: 1718153645993
                    nextToken: ''
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /update-flow:
    post:
      operationId: updateFlow
      summary: Amazon AppFlow Update Flow
      description: Updates an existing flow.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFlowRequest'
            examples:
              UpdateFlowRequestExample:
                summary: Default updateFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
                  description: Updated description
                  triggerConfig:
                    triggerType: Scheduled
                    triggerProperties:
                      Scheduled:
                        scheduleExpression: rate(6hours)
                  sourceFlowConfig:
                    connectorType: Salesforce
                    connectorProfileName: my-salesforce-profile
                    sourceConnectorProperties:
                      Salesforce:
                        object: Account
                  destinationFlowConfigList:
                  - connectorType: S3
                    destinationConnectorProperties:
                      S3:
                        bucketName: my-data-bucket
                        bucketPrefix: appflow/salesforce/accounts
                  tasks:
                  - taskType: Map
                    sourceFields:
                    - Id
                    destinationField: Id
                    taskProperties: {}
      responses:
        '200':
          description: Flow updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFlowResponse'
              examples:
                UpdateFlow200Example:
                  summary: Default updateFlow 200 response
                  x-microcks-default: true
                  value:
                    flowStatus: Active
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /start-flow:
    post:
      operationId: startFlow
      summary: Amazon AppFlow Start Flow
      description: Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow without modifying the configuration.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartFlowRequest'
            examples:
              StartFlowRequestExample:
                summary: Default startFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
      responses:
        '200':
          description: Flow started successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartFlowResponse'
              examples:
                StartFlow200Example:
                  summary: Default startFlow 200 response
                  x-microcks-default: true
                  value:
                    flowArn: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
                    flowStatus: Active
                    executionId: exec-500123
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /stop-flow:
    post:
      operationId: stopFlow
      summary: Amazon AppFlow Stop Flow
      description: Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopFlowRequest'
            examples:
              StopFlowRequestExample:
                summary: Default stopFlow request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
      responses:
        '200':
          description: Flow stopped successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopFlowResponse'
              examples:
                StopFlow200Example:
                  summary: Default stopFlow 200 response
                  x-microcks-default: true
                  value:
                    flowArn: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
                    flowStatus: Suspended
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /cancel-flow-executions:
    post:
      operationId: cancelFlowExecutions
      summary: Amazon AppFlow Cancel Flow Executions
      description: Cancels active runs for a flow. You can cancel all of the active runs for a flow, or you can cancel specific runs by providing their IDs.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelFlowExecutionsRequest'
            examples:
              CancelFlowExecutionsRequestExample:
                summary: Default cancelFlowExecutions request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
                  executionIds:
                  - exec-500123
      responses:
        '200':
          description: Flow executions cancelled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelFlowExecutionsResponse'
              examples:
                CancelFlowExecutions200Example:
                  summary: Default cancelFlowExecutions 200 response
                  x-microcks-default: true
                  value:
                    invalidExecutions:
                    - exec-invalid-123
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /describe-flow-execution-records:
    post:
      operationId: describeFlowExecutionRecords
      summary: Amazon AppFlow Describe Flow Execution Records
      description: Provides details regarding all instances for a given flow, based on the specified filter function, with a limit of 1000 records.
      tags:
      - Flows
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFlowExecutionRecordsRequest'
            examples:
              DescribeFlowExecutionRecordsRequestExample:
                summary: Default describeFlowExecutionRecords request
                x-microcks-default: true
                value:
                  flowName: my-salesforce-to-s3-flow
                  maxResults: 20
      responses:
        '200':
          description: Flow execution records returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFlowExecutionRecordsResponse'
              examples:
                DescribeFlowExecutionRecords200Example:
                  summary: Default describeFlowExecutionRecords 200 response
                  x-microcks-default: true
                  value:
                    flowExecutions:
                    - executionId: exec-500123
                      executionStatus: Successful
                      startedAt: 1718153645993
                      lastUpdatedAt: 1718153700000
                      executionResult:
                        recordsProcessed: 1500
                        bytesProcessed: 204800
                        bytesWritten: 204800
                    nextToken: ''
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Flow not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ExecutionDetails:
      type: object
      properties:
        mostRecentExecutionMessage:
          type: string
          description: Describes the details of the most recent flow run.
          example: Successfully ran the flow
        mostRecentExecutionTime:
          type: integer
          format: int64
          description: Specifies the time of the most recent flow run.
          example: 1718153700000
        mostRecentExecutionStatus:
          type: string
          description: Specifies the status of the most recent flow run.
          enum:
          - InProgress
          - Successful
          - Error
          - CancelStarted
          - Canceled
          example: Successful
    CancelFlowExecutionsResponse:
      type: object
      properties:
        invalidExecutions:
          type: array
          description: The IDs of runs that Amazon AppFlow couldn't cancel. The runs might have ended before the cancelation request was processed.
          items:
            type: string
            example: ''
          example:
          - exec-invalid-123
    CancelFlowExecutionsRequest:
      type: object
      required:
      - flowName
      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
    DescribeFlowResponse:
      type: object
      properties:
        flowArn:
          type: string
          description: The flow's Amazon Resource Name (ARN).
          example: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
        description:
          type: string
          description: A description of the flow.
          example: Transfer Salesforce accounts to S3 daily
        flowName:
          type: string
          description: The specified name of the flow.
          example: my-salesforce-to-s3-flow
        kmsArn:
          type: string
          description: The ARN of the AWS KMS key.
          example: arn:aws:kms:us-east-1:123456789012:key/mrk-1234abcd
        flowStatus:
          type: string
          description: Indicates the current status of the flow.
          enum:
          - Active
          - Deprecated
          - Deleted
          - Draft
          - Errored
          - Suspended
          example: Active
        flowStatusMessage:
          type: string
          description: Contains an error message if the flow status is in a suspended or error state.
          example: ''
        sourceFlowConfig:
          $ref: '#/components/schemas/SourceFlowConfig'
        destinationFlowConfigList:
          type: array
          items:
            $ref: '#/components/schemas/DestinationFlowConfig'
        lastRunExecutionDetails:
          $ref: '#/components/schemas/ExecutionDetails'
        triggerConfig:
          $ref: '#/components/schemas/TriggerConfig'
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/Task'
        createdAt:
          type: integer
          format: int64
          description: Specifies when the flow was created.
          example: 1718153645993
        lastUpdatedAt:
          type: integer
          format: int64
          description: Specifies when the flow was last updated.
          example: 1718153645993
        createdBy:
          type: string
          description: The ARN of the user who created the flow.
          example: arn:aws:iam::123456789012:user/admin
        lastUpdatedBy:
          type: string
          description: Specifies the account user name that most recently updated the flow.
          example: arn:aws:iam::123456789012:user/admin
        tags:
          type: object
          additionalProperties:
            type: string
          example:
            environment: production
        metadataCatalogConfig:
          $ref: '#/components/schemas/MetadataCatalogConfig'
        lastRunMetadataCatalogDetails:
          type: array
          items:
            type: object
    DescribeFlowRequest:
      type: object
      required:
      - flowName
      properties:
        flowName:
          type: string
          description: The specified name of the flow.
          maxLength: 256
          example: my-salesforce-to-s3-flow
    CreateFlowResponse:
      type: object
      properties:
        flowArn:
          type: string
          description: The flow's Amazon Resource Name (ARN).
          maxLength: 512
          example: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
        flowStatus:
          type: string
          description: Indicates the current status of the flow.
          enum:
          - Active
          - Deprecated
          - Deleted
          - Draft
          - Errored
          - Suspended
          example: Active
    Task:
      type: object
      required:
      - taskType
      - sourceFields
      properties:
        sourceFields:
          type: array
          description: The source fields to which a particular task is applied.
          items:
            type: string
            example: ''
          example:
          - Id
          - Name
        connectorOperator:
          type: object
          description: The operation to be performed on the provided source fields.
          example:
            Salesforce: NO_OP
        destinationField:
          type: string
          description: A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
          example: AccountId
        taskType:
          type: string
          description: Specifies the particular task implementation that Amazon AppFlow performs.
          enum:
          - Arithmetic
          - Filter
          - Map
          - Map_all
          - Mask
          - Merge
          - Partition
          - Passthrough
          - Truncate
          - Validate
          - Concat
          example: Map
        taskProperties:
          type: object
          description: A map used to store task-related information.
          additionalProperties:
            type: string
          example:
            SOURCE_DATA_TYPE: string
    ExecutionResult:
      type: object
      properties:
        errorInfo:
          type: object
          description: Provides any error message information related to the flow run.
        bytesProcessed:
          type: integer
          format: int64
          description: The total number of bytes processed by the flow run.
          example: 204800
        bytesWritten:
          type: integer
          format: int64
          description: The total number of bytes written as a result of the flow run.
          example: 204800
        recordsProcessed:
          type: integer
          format: int64
          description: The number of records processed in the flow run.
          example: 1500
        numParallelProcesses:
          type: integer
          format: int64
          description: The number of processes that Amazon AppFlow ran at the same time when it retrieved your data.
          example: 1
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: The error message describing what went wrong.
          example: The specified resource was not found.
        code:
          type: string
          description: The error code.
          example: ResourceNotFoundException
    UpdateFlowResponse:
      type: object
      properties:
        flowStatus:
          type: string
          description: Indicates the current status of the flow.
          enum:
          - Active
          - Deprecated
          - Deleted
          - Draft
          - Errored
          - Suspended
          example: Active
    FlowDefinition:
      type: object
      properties:
        flowArn:
          type: string
          description: The flow's Amazon Resource Name (ARN).
          example: arn:aws:appflow:us-east-1:123456789012:flow/my-salesforce-to-s3-flow
        description:
          type: string
          description: A user-entered description of the flow.
          example: Transfer Salesforce accounts to S3 daily
        flowName:
          type: string
          description: The specified name of the flow.
          example: my-salesforce-to-s3-flow
        flowStatus:
          type: string
          description: Indicates the current status of the flow.
          enum:
          - Active
          - Deprecated
          - Deleted
          - Draft
          - Errored
          - Suspended
          example: Active
        sourceConnectorType:
          type: string
          description: Specifies the source connector type.
          example: Salesforce
        sourceC

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-appflow/refs/heads/main/openapi/amazon-appflow-flows-api-openapi.yml