Amazon AppFlow API

openapi: 3.1.0
info:
  title: Amazon AppFlow 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
- name: Connectors
  description: Operations for managing connector profiles and connector registrations
- name: Tags
  description: Operations for managing resource tags
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
  /create-connector-profile:
    post:
      operationId: createConnectorProfile
      summary: Amazon AppFlow Create Connector Profile
      description: Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this 
        quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectorProfileRequest'
            examples:
              CreateConnectorProfileRequestExample:
                summary: Default createConnectorProfile request
                x-microcks-default: true
                value:
                  connectorProfileName: my-salesforce-profile
                  connectorType: Salesforce
                  connectionMode: Public
                  connectorProfileConfig:
                    connectorProfileCredentials:
                      Salesforce:
                        accessToken: eyJhbGciOiJSUzI1NiJ9...
                        refreshToken: 5Aep8614...
                    connectorProfileProperties:
                      Salesforce:
                        instanceUrl: https://myorg.salesforce.com
      responses:
        '200':
          description: Connector profile created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectorProfileResponse'
              examples:
                CreateConnectorProfile200Example:
                  summary: Default createConnectorProfile 200 response
                  x-microcks-default: true
                  value:
                    connectorProfileArn: arn:aws:appflow:us-east-1:123456789012:connectorprofile/my-salesforce-profile
        '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'
        '409':
          description: Conflict — profile 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-connector-profile:
    post:
      operationId: deleteConnectorProfile
      summary: Amazon AppFlow Delete Connector Profile
      description: Enables you to delete an existing connector profile.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteConnectorProfileRequest'
            examples:
              DeleteConnectorProfileRequestExample:
                summary: Default deleteConnectorProfile request
                x-microcks-default: true
                value:
                  connectorProfileName: my-salesforce-profile
                  forceDelete: false
      responses:
        '200':
          description: Connector profile deleted successfully
          content:
            application/json:
              schema:
                type: object
              examples:
                DeleteConnectorProfile200Example:
                  summary: Default deleteConnectorProfile 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: Connector profile not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — profile is in use by a flow
          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-connector-profiles:
    post:
      operationId: describeConnectorProfiles
      summary: Amazon AppFlow Describe Connector Profiles
      description: Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the 
        result. If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
      tags:
      - Connectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectorProfilesRequest'
            examples:
              DescribeConnectorProfilesRequestExample:
                summary: Default describeConnectorProfiles request
                x-microcks-default: true
                value:
                  connectorType: Salesforce
                  maxResults: 20
      responses:
        '200':
          description: Connector profiles returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectorProfilesResponse'
              examples:
                DescribeConnectorProfiles200Example:
                  summary: Default describeConnectorProfiles 200 response
                  x-microcks-default: true
                  value:
                    connectorProfileDetails:
                    - connectorProfileArn: arn:aws:appflow:us-east-1:123456789012:connectorprofile/my-salesforce-profile
                      connectorProfileName: my-salesforce-profile
                      connectorType: Salesforce
                      connectionMode: Public
                      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-connector-profile:
    post:
      operationId: updateConnectorProfile
      summary: Amazon AppFlow Update Connector Profile
      description: Updates a given connector profile associated with your account.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectorProfileRequest'
            examples:
              UpdateConnectorProfileRequestExample:
                summary: Default updateConnectorProfile request
                x-microcks-default: true
                value:
                  connectorProfileName: my-salesforce-profile
                  connectionMode: Public
                  connectorProfileConfig:
                    connectorProfileCredentials:
                      Salesforce:
                        accessToken: eyJhbGciOiJSUzI1NiJ9...
                        refreshToken: 5Aep8614...
                    connectorProfileProperties:
                      Salesforce:
                        instanceUrl: https://myorg.salesforce.com
      responses:
        '20

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