/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the appflow-2020-08-23.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.Appflow.Model; namespace Amazon.Appflow { /// /// 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. /// /// public partial interface IAmazonAppflow : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IAppflowPaginatorFactory Paginators { get; } #endif #region CancelFlowExecutions /// /// 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. /// /// /// /// Container for the necessary parameters to execute the CancelFlowExecutions service method. /// /// The response from the CancelFlowExecutions service method, as returned by Appflow. /// /// AppFlow/Requester has invalid or missing permissions. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// API calls have exceeded the maximum allowed API request rate per account and per Region. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for CancelFlowExecutions Operation CancelFlowExecutionsResponse CancelFlowExecutions(CancelFlowExecutionsRequest request); /// /// Initiates the asynchronous execution of the CancelFlowExecutions operation. /// /// /// Container for the necessary parameters to execute the CancelFlowExecutions operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCancelFlowExecutions /// operation. /// REST API Reference for CancelFlowExecutions Operation IAsyncResult BeginCancelFlowExecutions(CancelFlowExecutionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CancelFlowExecutions operation. /// /// /// The IAsyncResult returned by the call to BeginCancelFlowExecutions. /// /// Returns a CancelFlowExecutionsResult from Appflow. /// REST API Reference for CancelFlowExecutions Operation CancelFlowExecutionsResponse EndCancelFlowExecutions(IAsyncResult asyncResult); #endregion #region CreateConnectorProfile /// /// 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. /// /// Container for the necessary parameters to execute the CreateConnectorProfile service method. /// /// The response from the CreateConnectorProfile service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for CreateConnectorProfile Operation CreateConnectorProfileResponse CreateConnectorProfile(CreateConnectorProfileRequest request); /// /// Initiates the asynchronous execution of the CreateConnectorProfile operation. /// /// /// Container for the necessary parameters to execute the CreateConnectorProfile operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateConnectorProfile /// operation. /// REST API Reference for CreateConnectorProfile Operation IAsyncResult BeginCreateConnectorProfile(CreateConnectorProfileRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateConnectorProfile operation. /// /// /// The IAsyncResult returned by the call to BeginCreateConnectorProfile. /// /// Returns a CreateConnectorProfileResult from Appflow. /// REST API Reference for CreateConnectorProfile Operation CreateConnectorProfileResponse EndCreateConnectorProfile(IAsyncResult asyncResult); #endregion #region CreateFlow /// /// 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. /// /// Container for the necessary parameters to execute the CreateFlow service method. /// /// The response from the CreateFlow service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for CreateFlow Operation CreateFlowResponse CreateFlow(CreateFlowRequest request); /// /// Initiates the asynchronous execution of the CreateFlow operation. /// /// /// Container for the necessary parameters to execute the CreateFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCreateFlow /// operation. /// REST API Reference for CreateFlow Operation IAsyncResult BeginCreateFlow(CreateFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CreateFlow operation. /// /// /// The IAsyncResult returned by the call to BeginCreateFlow. /// /// Returns a CreateFlowResult from Appflow. /// REST API Reference for CreateFlow Operation CreateFlowResponse EndCreateFlow(IAsyncResult asyncResult); #endregion #region DeleteConnectorProfile /// /// Enables you to delete an existing connector profile. /// /// Container for the necessary parameters to execute the DeleteConnectorProfile service method. /// /// The response from the DeleteConnectorProfile service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// REST API Reference for DeleteConnectorProfile Operation DeleteConnectorProfileResponse DeleteConnectorProfile(DeleteConnectorProfileRequest request); /// /// Initiates the asynchronous execution of the DeleteConnectorProfile operation. /// /// /// Container for the necessary parameters to execute the DeleteConnectorProfile operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteConnectorProfile /// operation. /// REST API Reference for DeleteConnectorProfile Operation IAsyncResult BeginDeleteConnectorProfile(DeleteConnectorProfileRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteConnectorProfile operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteConnectorProfile. /// /// Returns a DeleteConnectorProfileResult from Appflow. /// REST API Reference for DeleteConnectorProfile Operation DeleteConnectorProfileResponse EndDeleteConnectorProfile(IAsyncResult asyncResult); #endregion #region DeleteFlow /// /// 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. /// /// Container for the necessary parameters to execute the DeleteFlow service method. /// /// The response from the DeleteFlow service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// REST API Reference for DeleteFlow Operation DeleteFlowResponse DeleteFlow(DeleteFlowRequest request); /// /// Initiates the asynchronous execution of the DeleteFlow operation. /// /// /// Container for the necessary parameters to execute the DeleteFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeleteFlow /// operation. /// REST API Reference for DeleteFlow Operation IAsyncResult BeginDeleteFlow(DeleteFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeleteFlow operation. /// /// /// The IAsyncResult returned by the call to BeginDeleteFlow. /// /// Returns a DeleteFlowResult from Appflow. /// REST API Reference for DeleteFlow Operation DeleteFlowResponse EndDeleteFlow(IAsyncResult asyncResult); #endregion #region DescribeConnector /// /// 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. /// /// Container for the necessary parameters to execute the DescribeConnector service method. /// /// The response from the DescribeConnector service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for DescribeConnector Operation DescribeConnectorResponse DescribeConnector(DescribeConnectorRequest request); /// /// Initiates the asynchronous execution of the DescribeConnector operation. /// /// /// Container for the necessary parameters to execute the DescribeConnector operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnector /// operation. /// REST API Reference for DescribeConnector Operation IAsyncResult BeginDescribeConnector(DescribeConnectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeConnector operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeConnector. /// /// Returns a DescribeConnectorResult from Appflow. /// REST API Reference for DescribeConnector Operation DescribeConnectorResponse EndDescribeConnector(IAsyncResult asyncResult); #endregion #region DescribeConnectorEntity /// /// Provides details regarding the entity used with the connector, with a description /// of the data model for each field in that entity. /// /// Container for the necessary parameters to execute the DescribeConnectorEntity service method. /// /// The response from the DescribeConnectorEntity service method, as returned by Appflow. /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for DescribeConnectorEntity Operation DescribeConnectorEntityResponse DescribeConnectorEntity(DescribeConnectorEntityRequest request); /// /// Initiates the asynchronous execution of the DescribeConnectorEntity operation. /// /// /// Container for the necessary parameters to execute the DescribeConnectorEntity operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnectorEntity /// operation. /// REST API Reference for DescribeConnectorEntity Operation IAsyncResult BeginDescribeConnectorEntity(DescribeConnectorEntityRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeConnectorEntity operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeConnectorEntity. /// /// Returns a DescribeConnectorEntityResult from Appflow. /// REST API Reference for DescribeConnectorEntity Operation DescribeConnectorEntityResponse EndDescribeConnectorEntity(IAsyncResult asyncResult); #endregion #region DescribeConnectorProfiles /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeConnectorProfiles service method. /// /// The response from the DescribeConnectorProfiles service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for DescribeConnectorProfiles Operation DescribeConnectorProfilesResponse DescribeConnectorProfiles(DescribeConnectorProfilesRequest request); /// /// Initiates the asynchronous execution of the DescribeConnectorProfiles operation. /// /// /// Container for the necessary parameters to execute the DescribeConnectorProfiles operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnectorProfiles /// operation. /// REST API Reference for DescribeConnectorProfiles Operation IAsyncResult BeginDescribeConnectorProfiles(DescribeConnectorProfilesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeConnectorProfiles operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeConnectorProfiles. /// /// Returns a DescribeConnectorProfilesResult from Appflow. /// REST API Reference for DescribeConnectorProfiles Operation DescribeConnectorProfilesResponse EndDescribeConnectorProfiles(IAsyncResult asyncResult); #endregion #region DescribeConnectors /// /// 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. /// /// Container for the necessary parameters to execute the DescribeConnectors service method. /// /// The response from the DescribeConnectors service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for DescribeConnectors Operation DescribeConnectorsResponse DescribeConnectors(DescribeConnectorsRequest request); /// /// Initiates the asynchronous execution of the DescribeConnectors operation. /// /// /// Container for the necessary parameters to execute the DescribeConnectors operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeConnectors /// operation. /// REST API Reference for DescribeConnectors Operation IAsyncResult BeginDescribeConnectors(DescribeConnectorsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeConnectors operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeConnectors. /// /// Returns a DescribeConnectorsResult from Appflow. /// REST API Reference for DescribeConnectors Operation DescribeConnectorsResponse EndDescribeConnectors(IAsyncResult asyncResult); #endregion #region DescribeFlow /// /// Provides a description of the specified flow. /// /// Container for the necessary parameters to execute the DescribeFlow service method. /// /// The response from the DescribeFlow service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// REST API Reference for DescribeFlow Operation DescribeFlowResponse DescribeFlow(DescribeFlowRequest request); /// /// Initiates the asynchronous execution of the DescribeFlow operation. /// /// /// Container for the necessary parameters to execute the DescribeFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlow /// operation. /// REST API Reference for DescribeFlow Operation IAsyncResult BeginDescribeFlow(DescribeFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeFlow operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeFlow. /// /// Returns a DescribeFlowResult from Appflow. /// REST API Reference for DescribeFlow Operation DescribeFlowResponse EndDescribeFlow(IAsyncResult asyncResult); #endregion #region DescribeFlowExecutionRecords /// /// Fetches the execution history of the flow. /// /// Container for the necessary parameters to execute the DescribeFlowExecutionRecords service method. /// /// The response from the DescribeFlowExecutionRecords service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for DescribeFlowExecutionRecords Operation DescribeFlowExecutionRecordsResponse DescribeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest request); /// /// Initiates the asynchronous execution of the DescribeFlowExecutionRecords operation. /// /// /// Container for the necessary parameters to execute the DescribeFlowExecutionRecords operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeFlowExecutionRecords /// operation. /// REST API Reference for DescribeFlowExecutionRecords Operation IAsyncResult BeginDescribeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeFlowExecutionRecords operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeFlowExecutionRecords. /// /// Returns a DescribeFlowExecutionRecordsResult from Appflow. /// REST API Reference for DescribeFlowExecutionRecords Operation DescribeFlowExecutionRecordsResponse EndDescribeFlowExecutionRecords(IAsyncResult asyncResult); #endregion #region ListConnectorEntities /// /// 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. /// /// Container for the necessary parameters to execute the ListConnectorEntities service method. /// /// The response from the ListConnectorEntities service method, as returned by Appflow. /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for ListConnectorEntities Operation ListConnectorEntitiesResponse ListConnectorEntities(ListConnectorEntitiesRequest request); /// /// Initiates the asynchronous execution of the ListConnectorEntities operation. /// /// /// Container for the necessary parameters to execute the ListConnectorEntities operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListConnectorEntities /// operation. /// REST API Reference for ListConnectorEntities Operation IAsyncResult BeginListConnectorEntities(ListConnectorEntitiesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListConnectorEntities operation. /// /// /// The IAsyncResult returned by the call to BeginListConnectorEntities. /// /// Returns a ListConnectorEntitiesResult from Appflow. /// REST API Reference for ListConnectorEntities Operation ListConnectorEntitiesResponse EndListConnectorEntities(IAsyncResult asyncResult); #endregion #region ListConnectors /// /// 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. /// /// Container for the necessary parameters to execute the ListConnectors service method. /// /// The response from the ListConnectors service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for ListConnectors Operation ListConnectorsResponse ListConnectors(ListConnectorsRequest request); /// /// Initiates the asynchronous execution of the ListConnectors operation. /// /// /// Container for the necessary parameters to execute the ListConnectors operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListConnectors /// operation. /// REST API Reference for ListConnectors Operation IAsyncResult BeginListConnectors(ListConnectorsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListConnectors operation. /// /// /// The IAsyncResult returned by the call to BeginListConnectors. /// /// Returns a ListConnectorsResult from Appflow. /// REST API Reference for ListConnectors Operation ListConnectorsResponse EndListConnectors(IAsyncResult asyncResult); #endregion #region ListFlows /// /// Lists all of the flows associated with your account. /// /// Container for the necessary parameters to execute the ListFlows service method. /// /// The response from the ListFlows service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for ListFlows Operation ListFlowsResponse ListFlows(ListFlowsRequest request); /// /// Initiates the asynchronous execution of the ListFlows operation. /// /// /// Container for the necessary parameters to execute the ListFlows operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListFlows /// operation. /// REST API Reference for ListFlows Operation IAsyncResult BeginListFlows(ListFlowsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListFlows operation. /// /// /// The IAsyncResult returned by the call to BeginListFlows. /// /// Returns a ListFlowsResult from Appflow. /// REST API Reference for ListFlows Operation ListFlowsResponse EndListFlows(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// Retrieves the tags that are associated with a specified flow. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from Appflow. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region RegisterConnector /// /// 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. /// /// Container for the necessary parameters to execute the RegisterConnector service method. /// /// The response from the RegisterConnector service method, as returned by Appflow. /// /// AppFlow/Requester has invalid or missing permissions. /// /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// /// API calls have exceeded the maximum allowed API request rate per account and per Region. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for RegisterConnector Operation RegisterConnectorResponse RegisterConnector(RegisterConnectorRequest request); /// /// Initiates the asynchronous execution of the RegisterConnector operation. /// /// /// Container for the necessary parameters to execute the RegisterConnector operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterConnector /// operation. /// REST API Reference for RegisterConnector Operation IAsyncResult BeginRegisterConnector(RegisterConnectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterConnector operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterConnector. /// /// Returns a RegisterConnectorResult from Appflow. /// REST API Reference for RegisterConnector Operation RegisterConnectorResponse EndRegisterConnector(IAsyncResult asyncResult); #endregion #region ResetConnectorMetadataCache /// /// 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. /// /// /// Container for the necessary parameters to execute the ResetConnectorMetadataCache service method. /// /// The response from the ResetConnectorMetadataCache service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for ResetConnectorMetadataCache Operation ResetConnectorMetadataCacheResponse ResetConnectorMetadataCache(ResetConnectorMetadataCacheRequest request); /// /// Initiates the asynchronous execution of the ResetConnectorMetadataCache operation. /// /// /// Container for the necessary parameters to execute the ResetConnectorMetadataCache operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndResetConnectorMetadataCache /// operation. /// REST API Reference for ResetConnectorMetadataCache Operation IAsyncResult BeginResetConnectorMetadataCache(ResetConnectorMetadataCacheRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ResetConnectorMetadataCache operation. /// /// /// The IAsyncResult returned by the call to BeginResetConnectorMetadataCache. /// /// Returns a ResetConnectorMetadataCacheResult from Appflow. /// REST API Reference for ResetConnectorMetadataCache Operation ResetConnectorMetadataCacheResponse EndResetConnectorMetadataCache(IAsyncResult asyncResult); #endregion #region StartFlow /// /// 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. /// /// Container for the necessary parameters to execute the StartFlow service method. /// /// The response from the StartFlow service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// REST API Reference for StartFlow Operation StartFlowResponse StartFlow(StartFlowRequest request); /// /// Initiates the asynchronous execution of the StartFlow operation. /// /// /// Container for the necessary parameters to execute the StartFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartFlow /// operation. /// REST API Reference for StartFlow Operation IAsyncResult BeginStartFlow(StartFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartFlow operation. /// /// /// The IAsyncResult returned by the call to BeginStartFlow. /// /// Returns a StartFlowResult from Appflow. /// REST API Reference for StartFlow Operation StartFlowResponse EndStartFlow(IAsyncResult asyncResult); #endregion #region StopFlow /// /// 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. /// /// Container for the necessary parameters to execute the StopFlow service method. /// /// The response from the StopFlow service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The requested operation is not supported for the current flow. /// /// REST API Reference for StopFlow Operation StopFlowResponse StopFlow(StopFlowRequest request); /// /// Initiates the asynchronous execution of the StopFlow operation. /// /// /// Container for the necessary parameters to execute the StopFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStopFlow /// operation. /// REST API Reference for StopFlow Operation IAsyncResult BeginStopFlow(StopFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StopFlow operation. /// /// /// The IAsyncResult returned by the call to BeginStopFlow. /// /// Returns a StopFlowResult from Appflow. /// REST API Reference for StopFlow Operation StopFlowResponse EndStopFlow(IAsyncResult asyncResult); #endregion #region TagResource /// /// Applies a tag to the specified flow. /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from Appflow. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region UnregisterConnector /// /// Unregisters the custom connector registered in your account that matches the connector /// label provided in the request. /// /// Container for the necessary parameters to execute the UnregisterConnector service method. /// /// The response from the UnregisterConnector service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// REST API Reference for UnregisterConnector Operation UnregisterConnectorResponse UnregisterConnector(UnregisterConnectorRequest request); /// /// Initiates the asynchronous execution of the UnregisterConnector operation. /// /// /// Container for the necessary parameters to execute the UnregisterConnector operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUnregisterConnector /// operation. /// REST API Reference for UnregisterConnector Operation IAsyncResult BeginUnregisterConnector(UnregisterConnectorRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UnregisterConnector operation. /// /// /// The IAsyncResult returned by the call to BeginUnregisterConnector. /// /// Returns a UnregisterConnectorResult from Appflow. /// REST API Reference for UnregisterConnector Operation UnregisterConnectorResponse EndUnregisterConnector(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Removes a tag from the specified flow. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by Appflow. /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from Appflow. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion #region UpdateConnectorProfile /// /// Updates a given connector profile associated with your account. /// /// Container for the necessary parameters to execute the UpdateConnectorProfile service method. /// /// The response from the UpdateConnectorProfile service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for UpdateConnectorProfile Operation UpdateConnectorProfileResponse UpdateConnectorProfile(UpdateConnectorProfileRequest request); /// /// Initiates the asynchronous execution of the UpdateConnectorProfile operation. /// /// /// Container for the necessary parameters to execute the UpdateConnectorProfile operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateConnectorProfile /// operation. /// REST API Reference for UpdateConnectorProfile Operation IAsyncResult BeginUpdateConnectorProfile(UpdateConnectorProfileRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateConnectorProfile operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateConnectorProfile. /// /// Returns a UpdateConnectorProfileResult from Appflow. /// REST API Reference for UpdateConnectorProfile Operation UpdateConnectorProfileResponse EndUpdateConnectorProfile(IAsyncResult asyncResult); #endregion #region UpdateConnectorRegistration /// /// Updates a custom connector that you've previously registered. This operation updates /// the connector with one of the following: /// /// /// /// Container for the necessary parameters to execute the UpdateConnectorRegistration service method. /// /// The response from the UpdateConnectorRegistration service method, as returned by Appflow. /// /// AppFlow/Requester has invalid or missing permissions. /// /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// /// API calls have exceeded the maximum allowed API request rate per account and per Region. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for UpdateConnectorRegistration Operation UpdateConnectorRegistrationResponse UpdateConnectorRegistration(UpdateConnectorRegistrationRequest request); /// /// Initiates the asynchronous execution of the UpdateConnectorRegistration operation. /// /// /// Container for the necessary parameters to execute the UpdateConnectorRegistration operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateConnectorRegistration /// operation. /// REST API Reference for UpdateConnectorRegistration Operation IAsyncResult BeginUpdateConnectorRegistration(UpdateConnectorRegistrationRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateConnectorRegistration operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateConnectorRegistration. /// /// Returns a UpdateConnectorRegistrationResult from Appflow. /// REST API Reference for UpdateConnectorRegistration Operation UpdateConnectorRegistrationResponse EndUpdateConnectorRegistration(IAsyncResult asyncResult); #endregion #region UpdateFlow /// /// Updates an existing flow. /// /// Container for the necessary parameters to execute the UpdateFlow service method. /// /// The response from the UpdateFlow service method, as returned by Appflow. /// /// There was a conflict when processing the request (for example, a flow with the given /// name already exists within the account. Check for conflicting resource names and try /// again. /// /// /// An error occurred when authenticating with the connector endpoint. /// /// /// An error occurred when retrieving data from the connector endpoint. /// /// /// An internal service error occurred during the processing of your request. Try again /// later. /// /// /// The resource specified in the request (such as the source or destination connector /// profile) is not found. /// /// /// The request would cause a service quota (such as the number of flows) to be exceeded. /// /// /// The request has invalid or missing parameters. /// /// REST API Reference for UpdateFlow Operation UpdateFlowResponse UpdateFlow(UpdateFlowRequest request); /// /// Initiates the asynchronous execution of the UpdateFlow operation. /// /// /// Container for the necessary parameters to execute the UpdateFlow operation on AmazonAppflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUpdateFlow /// operation. /// REST API Reference for UpdateFlow Operation IAsyncResult BeginUpdateFlow(UpdateFlowRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UpdateFlow operation. /// /// /// The IAsyncResult returned by the call to BeginUpdateFlow. /// /// Returns a UpdateFlowResult from Appflow. /// REST API Reference for UpdateFlow Operation UpdateFlowResponse EndUpdateFlow(IAsyncResult asyncResult); #endregion } }