View Source aws_appflow (aws v1.0.4)
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: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html: An alphabetical list of all Amazon AppFlow API operations.
Data types: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html: An alphabetical list of all Amazon AppFlow data types.
Common parameters: https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html: Parameters that all Query operations can use.
Common errors: https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html: 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: https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html.
Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such asauth-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 : https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm documentation.
Summary
Functions
Cancels active runs for a flow.
Creates a new connector profile associated with your Amazon Web Services account.
Enables your application to create a new flow using Amazon AppFlow.
Enables your application to delete an existing flow.
Describes the given custom connector registered in your Amazon Web Services account.
Returns a list of connector-profile
details matching the provided connector-profile
names and connector-types
.
Describes the connectors vended by Amazon AppFlow for specified connector types.
Returns the list of available connector entities supported by Amazon AppFlow.
Returns the list of all registered custom connectors in your Amazon Web Services account.
Registers a new custom connector with your Amazon Web Services account.
Resets metadata about your connector entities that Amazon AppFlow stored in its cache.
Activates an existing flow.
Deactivates the existing flow.
Updates a custom connector that you've previously registered.
Functions
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
.
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.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.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.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.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 orconnector-types
are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
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 anextToken
object, which can be be passed in to the next call to the DescribeConnectors
API operation to retrieve the next page.
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.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.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceRegisters 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.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.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.Deactivates the existing flow.
For on-demand flows, this operation returns anunsupportedOperationException
error message. For schedule and event-triggered flows, this operation deactivates the flow.
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