AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing 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:

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.

Inheritance Hierarchy

Amazon.Appflow.IAmazonAppflow

Namespace: Amazon.Appflow
Assembly: AWSSDK.Appflow.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonAppflow
         IAmazonService, IDisposable

The IAmazonAppflow type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Appflow.Model.IAppflowPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CancelFlowExecutions(CancelFlowExecutionsRequest)

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.

Public Method CancelFlowExecutionsAsync(CancelFlowExecutionsRequest, CancellationToken)

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.

Public Method CreateConnectorProfile(CreateConnectorProfileRequest)

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.

Public Method CreateConnectorProfileAsync(CreateConnectorProfileRequest, CancellationToken)

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.

Public Method CreateFlow(CreateFlowRequest)

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.

Public Method CreateFlowAsync(CreateFlowRequest, CancellationToken)

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.

Public Method DeleteConnectorProfile(DeleteConnectorProfileRequest)

Enables you to delete an existing connector profile.

Public Method DeleteConnectorProfileAsync(DeleteConnectorProfileRequest, CancellationToken)

Enables you to delete an existing connector profile.

Public Method DeleteFlow(DeleteFlowRequest)

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.

Public Method DeleteFlowAsync(DeleteFlowRequest, CancellationToken)

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.

Public Method DescribeConnector(DescribeConnectorRequest)

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.

Public Method DescribeConnectorAsync(DescribeConnectorRequest, CancellationToken)

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.

Public Method DescribeConnectorEntity(DescribeConnectorEntityRequest)

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

Public Method DescribeConnectorEntityAsync(DescribeConnectorEntityRequest, CancellationToken)

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

Public Method DescribeConnectorProfiles(DescribeConnectorProfilesRequest)

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.

Public Method DescribeConnectorProfilesAsync(DescribeConnectorProfilesRequest, CancellationToken)

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.

Public Method DescribeConnectors(DescribeConnectorsRequest)

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.

Public Method DescribeConnectorsAsync(DescribeConnectorsRequest, CancellationToken)

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.

Public Method DescribeFlow(DescribeFlowRequest)

Provides a description of the specified flow.

Public Method DescribeFlowAsync(DescribeFlowRequest, CancellationToken)

Provides a description of the specified flow.

Public Method DescribeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest)

Fetches the execution history of the flow.

Public Method DescribeFlowExecutionRecordsAsync(DescribeFlowExecutionRecordsRequest, CancellationToken)

Fetches the execution history of the flow.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method ListConnectorEntities(ListConnectorEntitiesRequest)

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.

Public Method ListConnectorEntitiesAsync(ListConnectorEntitiesRequest, CancellationToken)

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.

Public Method ListConnectors(ListConnectorsRequest)

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.

Public Method ListConnectorsAsync(ListConnectorsRequest, CancellationToken)

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.

Public Method ListFlows(ListFlowsRequest)

Lists all of the flows associated with your account.

Public Method ListFlowsAsync(ListFlowsRequest, CancellationToken)

Lists all of the flows associated with your account.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieves the tags that are associated with a specified flow.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieves the tags that are associated with a specified flow.

Public Method RegisterConnector(RegisterConnectorRequest)

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.

Public Method RegisterConnectorAsync(RegisterConnectorRequest, CancellationToken)

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.

Public Method ResetConnectorMetadataCache(ResetConnectorMetadataCacheRequest)

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.

Public Method ResetConnectorMetadataCacheAsync(ResetConnectorMetadataCacheRequest, CancellationToken)

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.

Public Method StartFlow(StartFlowRequest)

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.

Public Method StartFlowAsync(StartFlowRequest, CancellationToken)

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.

Public Method StopFlow(StopFlowRequest)

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.

Public Method StopFlowAsync(StopFlowRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

Applies a tag to the specified flow.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Applies a tag to the specified flow.

Public Method UnregisterConnector(UnregisterConnectorRequest)

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Public Method UnregisterConnectorAsync(UnregisterConnectorRequest, CancellationToken)

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Public Method UntagResource(UntagResourceRequest)

Removes a tag from the specified flow.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes a tag from the specified flow.

Public Method UpdateConnectorProfile(UpdateConnectorProfileRequest)

Updates a given connector profile associated with your account.

Public Method UpdateConnectorProfileAsync(UpdateConnectorProfileRequest, CancellationToken)

Updates a given connector profile associated with your account.

Public Method UpdateConnectorRegistration(UpdateConnectorRegistrationRequest)

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

Public Method UpdateConnectorRegistrationAsync(UpdateConnectorRegistrationRequest, CancellationToken)

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

Public Method UpdateFlow(UpdateFlowRequest)

Updates an existing flow.

Public Method UpdateFlowAsync(UpdateFlowRequest, CancellationToken)

Updates an existing flow.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5