Amazon Web Services, Inc.

Amazon Appflow

Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types,…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Amazon AppFlow API reference. This guide is for developers who need
detailed information about the Amazon AppFlow API operations, data types, and errors.
Amazon AppFlow is a fully managed integration service that enables you to securely
transfer data between software as a service (SaaS) applications like Salesforce, Marketo,
Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.
Use the following links to get started on the Amazon AppFlow API:

Actions : An alphabetical list of all Amazon AppFlow API operations.

Data
types : An alphabetical list of all Amazon AppFlow data types.

Common parameters : Parameters that all Query operations can use.

Common
errors : Client and server errors that all operations can return.

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow
User Guide .
Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include
applicable OAuth attributes (such as auth-code and redirecturi ) with
the connector-specific ConnectorProfileProperties when creating a new connector
profile using Amazon AppFlow API operations. For example, Salesforce users can refer to
the
Authorize Apps with OAuth
documentation.

Endpoints 25

  • POSTCancel flow executions/cancel-flow-executionsCancels 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. You can cancel a…
  • POSTCreate connector profile/create-connector-profileCreates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services…
  • POSTCreate flow/create-flowEnables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request…
  • POSTDelete connector profile/delete-connector-profileEnables you to delete an existing connector profile.
  • POSTDelete flow/delete-flowEnables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and…
  • POSTDescribe connector/describe-connectorDescribes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your…
  • POSTDescribe connector entity/describe-connector-entityProvides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
  • POSTDescribe connector profiles/describe-connector-profilesReturns a list of connector-profile details matching the provided connector-profile names and connector-types . Both input lists are optional, and you can use…
  • POSTDescribe connectors/describe-connectorsDescribes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all…
  • POSTDescribe flow/describe-flowProvides a description of the specified flow.
  • POSTDescribe flow execution records/describe-flow-execution-recordsFetches the execution history of the flow.
  • POSTList connector entities/list-connector-entitiesReturns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or…
  • POSTList connectors/list-connectorsReturns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account,…
  • POSTList flows/list-flowsLists all of the flows associated with your account.
  • GETList tags for resource/tags/:resourceArnRetrieves the tags that are associated with a specified flow.
  • POSTTag resource/tags/:resourceArnApplies a tag to the specified flow.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from the specified flow.
  • POSTRegister connector/register-connectorRegisters a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda…
  • POSTReset connector metadata cache/reset-connector-metadata-cacheResets metadata about your connector entities that Amazon AppFlow stored in its cache. Use this action when you want Amazon AppFlow to return the latest…
  • POSTStart flow/start-flowActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates…
  • POSTStop flow/stop-flowDeactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered…
  • POSTUnregister connector/unregister-connectorUnregisters the custom connector registered in your account that matches the connector label provided in the request.
  • POSTUpdate connector profile/update-connector-profileUpdates a given connector profile associated with your account.
  • POSTUpdate connector registration/update-connector-registrationUpdates a custom connector that you've previously registered. This operation updates the connector with one of the following: The latest version of the AWS…
  • POSTUpdate flow/update-flowUpdates an existing flow.

API details

Base URL
https://appflow.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
25 operations on 23 pathsPOST 23GET 1DELETE 1
Description format
AWS Smithy model, API version 2020-08-23

How to test the Amazon Appflow in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Appflow collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel flow executions” (POST /cancel-flow-executions), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Appflow?

Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types,… It is listed under Developer tools and has 25 endpoints.

Who publishes the Amazon Appflow?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Appflow?

Requests go to https://appflow.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Appflow?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Appflow have?

25 operations on 23 paths (23 POST, 1 GET, 1 DELETE).

Is forking the Amazon Appflow free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.