AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <AppflowClient.h>
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.
Definition at line 47 of file AppflowClient.h.
Definition at line 50 of file AppflowClient.h.
Definition at line 54 of file AppflowClient.h.
Definition at line 55 of file AppflowClient.h.
Aws::Appflow::AppflowClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Appflow::AppflowClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Appflow::AppflowClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
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.
nullptr
An Async wrapper for CancelFlowExecutions that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 142 of file AppflowClient.h.
A Callable wrapper for CancelFlowExecutions that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 133 of file AppflowClient.h.
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.
nullptr
An Async wrapper for CreateConnectorProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 172 of file AppflowClient.h.
A Callable wrapper for CreateConnectorProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 163 of file AppflowClient.h.
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.
nullptr
An Async wrapper for CreateFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 202 of file AppflowClient.h.
A Callable wrapper for CreateFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 193 of file AppflowClient.h.
nullptr
An Async wrapper for DeleteConnectorProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 228 of file AppflowClient.h.
A Callable wrapper for DeleteConnectorProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 219 of file AppflowClient.h.
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.
nullptr
An Async wrapper for DeleteFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 255 of file AppflowClient.h.
A Callable wrapper for DeleteFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 246 of file AppflowClient.h.
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.
nullptr
An Async wrapper for DescribeConnector that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 282 of file AppflowClient.h.
A Callable wrapper for DescribeConnector that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 273 of file AppflowClient.h.
Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
nullptr
An Async wrapper for DescribeConnectorEntity that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 309 of file AppflowClient.h.
A Callable wrapper for DescribeConnectorEntity that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 300 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeConnectorProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 339 of file AppflowClient.h.
{}
)
const
A Callable wrapper for DescribeConnectorProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 330 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for DescribeConnectors that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 370 of file AppflowClient.h.
{}
)
const
A Callable wrapper for DescribeConnectors that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 361 of file AppflowClient.h.
nullptr
An Async wrapper for DescribeFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 395 of file AppflowClient.h.
A Callable wrapper for DescribeFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 386 of file AppflowClient.h.
nullptr
An Async wrapper for DescribeFlowExecutionRecords that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 420 of file AppflowClient.h.
A Callable wrapper for DescribeFlowExecutionRecords that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 411 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListConnectorEntities that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 448 of file AppflowClient.h.
{}
)
const
A Callable wrapper for ListConnectorEntities that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 439 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ListConnectors that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 476 of file AppflowClient.h.
{}
)
const
A Callable wrapper for ListConnectors that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 467 of file AppflowClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListFlows that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 502 of file AppflowClient.h.
{}
)
const
A Callable wrapper for ListFlows that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 493 of file AppflowClient.h.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 528 of file AppflowClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 519 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for RegisterConnector that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 555 of file AppflowClient.h.
{}
)
const
A Callable wrapper for RegisterConnector that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 546 of file AppflowClient.h.
{}
)
const
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.
nullptr
,
{}
An Async wrapper for ResetConnectorMetadataCache that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 588 of file AppflowClient.h.
{}
)
const
A Callable wrapper for ResetConnectorMetadataCache that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 579 of file AppflowClient.h.
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.
nullptr
An Async wrapper for StartFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 615 of file AppflowClient.h.
A Callable wrapper for StartFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 606 of file AppflowClient.h.
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.
nullptr
An Async wrapper for StopFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 643 of file AppflowClient.h.
A Callable wrapper for StopFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 634 of file AppflowClient.h.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 668 of file AppflowClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 659 of file AppflowClient.h.
Unregisters the custom connector registered in your account that matches the connector label provided in the request.
nullptr
An Async wrapper for UnregisterConnector that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 694 of file AppflowClient.h.
A Callable wrapper for UnregisterConnector that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 685 of file AppflowClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 719 of file AppflowClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 710 of file AppflowClient.h.
nullptr
An Async wrapper for UpdateConnectorProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 745 of file AppflowClient.h.
A Callable wrapper for UpdateConnectorProfile that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 736 of file AppflowClient.h.
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
nullptr
An Async wrapper for UpdateConnectorRegistration that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 774 of file AppflowClient.h.
A Callable wrapper for UpdateConnectorRegistration that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 765 of file AppflowClient.h.
nullptr
An Async wrapper for UpdateFlow that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 799 of file AppflowClient.h.
A Callable wrapper for UpdateFlow that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 790 of file AppflowClient.h.
Definition at line 806 of file AppflowClient.h.