1---2name: amazon-appflow3description: Amazon Appflow API skill. Use when working with Amazon Appflow for cancel-flow-executions, create-connector-profile, create-flow. Covers 25 endpoints.4---5
6# Amazon Appflow
7API version: 2020-08-23
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /tags/{resourceArn} -- verify access
183. POST /cancel-flow-executions -- create first cancel-flow-executions
19
20## Endpoints
21
2225 endpoints across 23 groups. See references/api-spec.lap for full details.
23
24### cancel-flow-executions
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /cancel-flow-executions | 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. You can cancel a flow run only when the run is in progress. You can't cancel a run that has already completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To prevent a scheduled run, you can deactivate the flow with the StopFlow action. You cannot resume a run after you cancel it. When you send your request, the status for each run becomes CancelStarted. When the cancellation completes, the status becomes Canceled. When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing. |
28
29### create-connector-profile
30| Method | Path | Description |
31|--------|------|-------------|
32| POST | /create-connector-profile | Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services 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. In each connector profile that you create, you can provide the credentials and properties for only one connector. |
33
34### create-flow
35| Method | Path | Description |
36|--------|------|-------------|
37| POST | /create-flow | Enables 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 Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once. |
38
39### delete-connector-profile
40| Method | Path | Description |
41|--------|------|-------------|
42| POST | /delete-connector-profile | Enables you to delete an existing connector profile. |
43
44### delete-flow
45| Method | Path | Description |
46|--------|------|-------------|
47| POST | /delete-flow | 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. |
48
49### describe-connector
50| Method | Path | Description |
51|--------|------|-------------|
52| POST | /describe-connector | Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors. |
53
54### describe-connector-entity
55| Method | Path | Description |
56|--------|------|-------------|
57| POST | /describe-connector-entity | Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity. |
58
59### describe-connector-profiles
60| Method | Path | Description |
61|--------|------|-------------|
62| POST | /describe-connector-profiles | 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. |
63
64### describe-connectors
65| Method | Path | Description |
66|--------|------|-------------|
67| POST | /describe-connectors | 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. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page. |
68
69### describe-flow
70| Method | Path | Description |
71|--------|------|-------------|
72| POST | /describe-flow | Provides a description of the specified flow. |
73
74### describe-flow-execution-records
75| Method | Path | Description |
76|--------|------|-------------|
77| POST | /describe-flow-execution-records | Fetches the execution history of the flow. |
78
79### list-connector-entities
80| Method | Path | Description |
81|--------|------|-------------|
82| POST | /list-connector-entities | 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. |
83
84### list-connectors
85| Method | Path | Description |
86|--------|------|-------------|
87| POST | /list-connectors | 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 Amazon Web Services authored connectors. |
88
89### list-flows
90| Method | Path | Description |
91|--------|------|-------------|
92| POST | /list-flows | Lists all of the flows associated with your account. |
93
94### tags
95| Method | Path | Description |
96|--------|------|-------------|
97| GET | /tags/{resourceArn} | Retrieves the tags that are associated with a specified flow. |
98| POST | /tags/{resourceArn} | Applies a tag to the specified flow. |
99| DELETE | /tags/{resourceArn} | Removes a tag from the specified flow. |
100
101### register-connector
102| Method | Path | Description |
103|--------|------|-------------|
104| POST | /register-connector | 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. |
105
106### reset-connector-metadata-cache
107| Method | Path | Description |
108|--------|------|-------------|
109| POST | /reset-connector-metadata-cache | 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. Amazon AppFlow returns metadata about your entities when you use the ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to the source application. Amazon AppFlow automatically resets the cache once every hour, but you can use this action when you want to get the latest metadata right away. |
110
111### start-flow
112| Method | Path | Description |
113|--------|------|-------------|
114| POST | /start-flow | 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. |
115
116### stop-flow
117| Method | Path | Description |
118|--------|------|-------------|
119| POST | /stop-flow | 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. |
120
121### unregister-connector
122| Method | Path | Description |
123|--------|------|-------------|
124| POST | /unregister-connector | Unregisters the custom connector registered in your account that matches the connector label provided in the request. |
125
126### update-connector-profile
127| Method | Path | Description |
128|--------|------|-------------|
129| POST | /update-connector-profile | Updates a given connector profile associated with your account. |
130
131### update-connector-registration
132| Method | Path | Description |
133|--------|------|-------------|
134| POST | /update-connector-registration | 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 A new AWS Lambda function that you specify |
135
136### update-flow
137| Method | Path | Description |
138|--------|------|-------------|
139| POST | /update-flow | Updates an existing flow. |
140
141## Common Questions
142
143Match user requests to endpoints in references/api-spec.lap. Key patterns:
144- "Create a cancel-flow-execution?" -> POST /cancel-flow-executions
145- "Create a create-connector-profile?" -> POST /create-connector-profile
146- "Create a create-flow?" -> POST /create-flow
147- "Create a delete-connector-profile?" -> POST /delete-connector-profile
148- "Create a delete-flow?" -> POST /delete-flow
149- "Create a describe-connector?" -> POST /describe-connector
150- "Create a describe-connector-entity?" -> POST /describe-connector-entity
151- "Create a describe-connector-profile?" -> POST /describe-connector-profiles
152- "Create a describe-connector?" -> POST /describe-connectors
153- "Create a describe-flow?" -> POST /describe-flow
154- "Create a describe-flow-execution-record?" -> POST /describe-flow-execution-records
155- "Create a list-connector-entity?" -> POST /list-connector-entities
156- "Create a list-connector?" -> POST /list-connectors
157- "Create a list-flow?" -> POST /list-flows
158- "Get tag details?" -> GET /tags/{resourceArn}
159- "Create a register-connector?" -> POST /register-connector
160- "Create a reset-connector-metadata-cache?" -> POST /reset-connector-metadata-cache
161- "Create a start-flow?" -> POST /start-flow
162- "Create a stop-flow?" -> POST /stop-flow
163- "Create a unregister-connector?" -> POST /unregister-connector
164- "Delete a tag?" -> DELETE /tags/{resourceArn}
165- "Create a update-connector-profile?" -> POST /update-connector-profile
166- "Create a update-connector-registration?" -> POST /update-connector-registration
167- "Create a update-flow?" -> POST /update-flow
168- "How to authenticate?" -> See Auth section
169
170## Response Tips
171- Check response schemas in references/api-spec.lap for field details
172- Create/update endpoints typically return the created/updated object
173
174## References
175- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
176
177> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform