Amazon AppFlow Connectors API

openapi: 3.1.0
info:
  title: Amazon AppFlow Connectors 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: Connectors
  description: Operations for managing connector profiles and connector registrations
paths:
  /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:
        '200':
          description: Connector profile updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectorProfileResponse'
              examples:
                UpdateConnectorProfile200Example:
                  summary: Default updateConnectorProfile 200 response
                  x-microcks-default: true
                  value:
                    connectorProfileArn: arn:aws:appflow:us-east-1:123456789012:connectorprofile/my-salesforce-profile
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Connector authentication 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'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /describe-connectors:
    post:
      operationId: describeConnectors
      summary: Amazon AppFlow Describe Connectors
      description: Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. This API lists only custom connectors registered in this account, not the AWS authored connectors.
      tags:
      - Connectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectorsRequest'
            examples:
              DescribeConnectorsRequestExample:
                summary: Default describeConnectors request
                x-microcks-default: true
                value:
                  connectorTypes:
                  - Salesforce
                  - S3
                  maxResults: 20
      responses:
        '200':
          description: Connectors described successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectorsResponse'
              examples:
                DescribeConnectors200Example:
                  summary: Default describeConnectors 200 response
                  x-microcks-default: true
                  value:
                    connectorConfigurations:
                      Salesforce:
                        canUseAsSource: true
                        canUseAsDestination: true
                        isPrivateLinkEnabled: false
                        isPrivateLinkEndpointUrlRequired: false
                    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
  /describe-connector:
    post:
      operationId: describeConnector
      summary: Amazon AppFlow Describe Connector
      description: Describes the given custom connector registered in your AWS account.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectorRequest'
            examples:
              DescribeConnectorRequestExample:
                summary: Default describeConnector request
                x-microcks-default: true
                value:
                  connectorType: CustomConnector
                  connectorLabel: MyCustomConnector
      responses:
        '200':
          description: Connector description returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectorResponse'
              examples:
                DescribeConnector200Example:
                  summary: Default describeConnector 200 response
                  x-microcks-default: true
                  value:
                    connectorConfiguration:
                      connectorArn: arn:aws:appflow:us-east-1:123456789012:connector/MyCustomConnector
                      connectorLabel: MyCustomConnector
                      connectorDescription: My custom connector
                      connectorOwner: '123456789012'
                      connectorVersion: '1.0'
                      connectorModes:
                      - CLOUD
                      canUseAsSource: true
                      canUseAsDestination: true
        '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 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-connector-entity:
    post:
      operationId: describeConnectorEntity
      summary: Amazon AppFlow Describe Connector Entity
      description: Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeConnectorEntityRequest'
            examples:
              DescribeConnectorEntityRequestExample:
                summary: Default describeConnectorEntity request
                x-microcks-default: true
                value:
                  connectorEntityName: Account
                  connectorType: Salesforce
                  connectorProfileName: my-salesforce-profile
      responses:
        '200':
          description: Connector entity described successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeConnectorEntityResponse'
              examples:
                DescribeConnectorEntity200Example:
                  summary: Default describeConnectorEntity 200 response
                  x-microcks-default: true
                  value:
                    connectorEntityFields:
                    - identifier: Id
                      label: Account ID
                      isPrimaryKey: true
                      isQueryable: true
                      isRetrievable: true
                      isWritable: false
                      supportedFieldTypeDetails:
                        v1:
                          fieldType: id
                          filterOperators:
                          - EQUAL_TO
        '400':
          description: Validation error or connector error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Connector authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Connector 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-connector-entities:
    post:
      operationId: listConnectorEntities
      summary: Amazon AppFlow List Connector Entities
      description: Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.
      tags:
      - Connectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorEntitiesRequest'
            examples:
              ListConnectorEntitiesRequestExample:
                summary: Default listConnectorEntities request
                x-microcks-default: true
                value:
                  connectorType: Salesforce
                  connectorProfileName: my-salesforce-profile
                  entitiesPath: ''
      responses:
        '200':
          description: Connector entities listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorEntitiesResponse'
              examples:
                ListConnectorEntities200Example:
                  summary: Default listConnectorEntities 200 response
                  x-microcks-default: true
                  value:
                    connectorEntityMap:
                      Objects:
                      - name: Account
                        label: Account
                        hasNestedEntities: false
                      - name: Contact
                        label: Contact
                        hasNestedEntities: false
                      - name: Opportunity
                        label: Opportunity
                        hasNestedEntities: false
                    nextToken: ''
        '400':
          description: Validation error or connector error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Connector authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Connector 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-connectors:
    post:
      operationId: listConnectors
      summary: Amazon AppFlow List Connectors
      description: Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the AWS authored connectors.
      tags:
      - Connectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListConnectorsRequest'
            examples:
              ListConnectorsRequestExample:
                summary: Default listConnectors request
                x-microcks-default: true
                value:
                  maxResults: 20
      responses:
        '200':
          description: Connectors listed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListConnectorsResponse'
              examples:
                ListConnectors200Example:
                  summary: Default listConnectors 200 response
                  x-microcks-default: true
                  value:
                    connectors:
                    - connectorArn: arn:aws:appflow:us-east-1:123456789012:connector/MyCustomConnector
                      connectorLabel: MyCustomConnector
                      connectorDescription: My custom connector
                      connectorType: CustomConnector
                      connectorModes:
                      - CLOUD
                    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
  /register-connector:
    post:
      operationId: registerConnector
      summary: Amazon AppFlow Register Connector
      description: Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterConnectorRequest'
            examples:
              RegisterConnectorRequestExample:
                summary: Default registerConnector request
                x-microcks-default: true
                value:
                  connectorLabel: MyCustomConnector
                  description: My custom connector for proprietary data source
                  connectorProvisioningType: LAMBDA
                  connectorProvisioningConfig:
                    lambda:
                      lambdaArn: arn:aws:lambda:us-east-1:123456789012:function:my-connector-function
      responses:
        '200':
          description: Connector registered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterConnectorResponse'
              examples:
                RegisterConnector200Example:
                  summary: Default registerConnector 200 response
                  x-microcks-default: true
                  value:
                    connectorArn: arn:aws:appflow:us-east-1:123456789012:connector/MyCustomConnector
        '400':
          description: Validation error or connector server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — connector with this label 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
  /unregister-connector:
    post:
      operationId: unregisterConnector
      summary: Amazon AppFlow Unregister Connector
      description: Unregisters the custom connector registered in your account that matches the connector label provided in the request.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnregisterConnectorRequest'
            examples:
              UnregisterConnectorRequestExample:
                summary: Default unregisterConnector request
                x-microcks-default: true
                value:
                  connectorLabel: MyCustomConnector
                  forceDelete: false
      responses:
        '200':
          description: Connector unregistered successfully
          content:
            application/json:
              schema:
                type: object
              examples:
                UnregisterConnector200Example:
                  summary: Default unregisterConnector 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 not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — connector 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
  /update-connector-registration:
    post:
      operationId: updateConnectorRegistration
      summary: Amazon AppFlow Update Connector Registration
      description: Updates a custom connector that you've previously registered. This operation updates the connector with one of the following — the latest version of the AWS Lambda function that's assigned to the connector, or a new AWS Lambda function that you specify.
      tags:
      - Connectors
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateConnectorRegistrationRequest'
            examples:
              UpdateConnectorRegistrationRequestExample:
                summary: Default updateConnectorRegistration request
                x-microcks-default: true
                value:
                  connectorLabel: MyCustomConnector
                  description: Updated description for my connector
                  connectorProvisioningConfig:
                    lambda:
                      lambdaArn: arn:aws:lambda:us-east-1:123456789012:function:my-connector-function-v2
      responses:
        '200':
          description: Connector registration updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateConnectorRegistrationResponse'
              examples:
                UpdateConnectorRegistration200Example:
                  summary: Default updateConnectorRegistration 200 response
                  x-microcks-default: true
                  value:
                    connectorArn: arn:aws:appflow:us-east-1:123456789012:connector/MyCustomConnector
        '400':
          description: Validation error or connector server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Connector 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
  /reset-connector-metadata-cache:
    post:
      operationId: resetConnectorMetadataCache
      summary: Amazon AppFlow Reset Connector Metadata Cache
      description: Resets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest information about the data that you have in a source application.
      tags:
      - Connectors
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResetConnectorMetadataCacheRequest'
            examples:
              ResetConnectorMetadataCacheRequestExample:
                summary: Default resetConnectorMetadataCache request
                x-microcks-default: true
                value:
                  connectorType: Salesforce
                  connectorProfileName: my-salesforce-profile
                  connectorEntityName: Account
                  entitiesPath: ''
      responses:
        '200':
          description: Connector metadata cache reset successfully
          content:
            application/json:
              schema:
                type: object
              examples:
                ResetC

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