amazonaws.com – 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, 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:
-
: An alphabetical list of all Amazon AppFlow API operations.
-
: An alphabetical list of all Amazon AppFlow data types.
-
: Parameters that all Query operations can use.
-
: Client and server errors that all operations can return.
If you're new to Amazon AppFlow, we recommend that you review the .
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 documentation.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:appflow/2020-08-23.json
- Provider
- amazonaws.com:appflow / appflow
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/appflow/2020-08-23/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/appflow/2020-08-23/openapi.yaml
Tools (25)
Extracted live via the executor SDK.
-
createConnectorProfile.postOperationCreates 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.
-
createFlow.postOperationEnables 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.
-
deleteConnectorProfile.postOperationEnables you to delete an existing connector profile.
-
deleteFlow.postOperationEnables 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.
-
describeConnector.postOperationDescribes 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.
-
describeConnectorEntity.postOperationProvides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
-
describeConnectorProfiles.postOperationReturns a list of
connector-profiledetails matching the providedconnector-profilenames andconnector-types. Both input lists are optional, and you can use them to filter the result.If no names or
connector-typesare provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list. -
describeConnectors.postOperationDescribes 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
nextTokenobject, which can be be passed in to the next call to theDescribeConnectorsAPI operation to retrieve the next page. -
describeFlow.postOperationProvides a description of the specified flow.
-
describeFlowExecutionRecords.postOperationFetches the execution history of the flow.
-
listConnectorEntities.postOperationReturns 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.
-
listConnectors.postOperationReturns 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.
-
listFlows.postOperationLists all of the flows associated with your account.
-
registerConnector.postOperationRegisters 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.
-
startFlow.postOperationActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
-
stopFlow.postOperationDeactivates the existing flow. For on-demand flows, this operation returns an
unsupportedOperationExceptionerror message. For schedule and event-triggered flows, this operation deactivates the flow. -
tags.listTagsForResourceRetrieves the tags that are associated with a specified flow.
-
tags.tagResourceApplies a tag to the specified flow.
-
tags.untagResourceRemoves a tag from the specified flow.
-
unregisterConnector.postOperationUnregisters the custom connector registered in your account that matches the connector label provided in the request.
-
updateConnectorProfile.postOperationUpdates a given connector profile associated with your account.
-
updateConnectorRegistration.postOperationUpdates 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
-
-
updateFlow.postOperationUpdates an existing flow.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools