com.amazonaws.services.appflow.AmazonAppflowAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-appflow Show documentation
/*
* Copyright 2019-2024 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.
*/
package com.amazonaws.services.appflow;
import javax.annotation.Generated;
import com.amazonaws.services.appflow.model.*;
/**
* Interface for accessing Amazon Appflow asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.appflow.AbstractAmazonAppflowAsync} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppflowAsync extends AmazonAppflow {
/**
*
* 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.
*
*
*
* @param cancelFlowExecutionsRequest
* @return A Java Future containing the result of the CancelFlowExecutions operation returned by the service.
* @sample AmazonAppflowAsync.CancelFlowExecutions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future cancelFlowExecutionsAsync(CancelFlowExecutionsRequest 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.
*
*
*
* @param cancelFlowExecutionsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CancelFlowExecutions operation returned by the service.
* @sample AmazonAppflowAsyncHandler.CancelFlowExecutions
* @see AWS
* API Documentation
*/
java.util.concurrent.Future cancelFlowExecutionsAsync(CancelFlowExecutionsRequest cancelFlowExecutionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createConnectorProfileRequest
* @return A Java Future containing the result of the CreateConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsync.CreateConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createConnectorProfileAsync(CreateConnectorProfileRequest 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.
*
*
* @param createConnectorProfileRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsyncHandler.CreateConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createConnectorProfileAsync(CreateConnectorProfileRequest createConnectorProfileRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createFlowRequest
* @return A Java Future containing the result of the CreateFlow operation returned by the service.
* @sample AmazonAppflowAsync.CreateFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createFlowAsync(CreateFlowRequest 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.
*
*
* @param createFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.CreateFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createFlowAsync(CreateFlowRequest createFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Enables you to delete an existing connector profile.
*
*
* @param deleteConnectorProfileRequest
* @return A Java Future containing the result of the DeleteConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsync.DeleteConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteConnectorProfileAsync(DeleteConnectorProfileRequest deleteConnectorProfileRequest);
/**
*
* Enables you to delete an existing connector profile.
*
*
* @param deleteConnectorProfileRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DeleteConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deleteConnectorProfileAsync(DeleteConnectorProfileRequest deleteConnectorProfileRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteFlowRequest
* @return A Java Future containing the result of the DeleteFlow operation returned by the service.
* @sample AmazonAppflowAsync.DeleteFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteFlowAsync(DeleteFlowRequest 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.
*
*
* @param deleteFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DeleteFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteFlowAsync(DeleteFlowRequest deleteFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeConnectorRequest
* @return A Java Future containing the result of the DescribeConnector operation returned by the service.
* @sample AmazonAppflowAsync.DescribeConnector
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeConnectorAsync(DescribeConnectorRequest 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.
*
*
* @param describeConnectorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnector operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DescribeConnector
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeConnectorAsync(DescribeConnectorRequest describeConnectorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides details regarding the entity used with the connector, with a description of the data model for each
* field in that entity.
*
*
* @param describeConnectorEntityRequest
* @return A Java Future containing the result of the DescribeConnectorEntity operation returned by the service.
* @sample AmazonAppflowAsync.DescribeConnectorEntity
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectorEntityAsync(DescribeConnectorEntityRequest describeConnectorEntityRequest);
/**
*
* Provides details regarding the entity used with the connector, with a description of the data model for each
* field in that entity.
*
*
* @param describeConnectorEntityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectorEntity operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DescribeConnectorEntity
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectorEntityAsync(DescribeConnectorEntityRequest describeConnectorEntityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeConnectorProfilesRequest
* @return A Java Future containing the result of the DescribeConnectorProfiles operation returned by the service.
* @sample AmazonAppflowAsync.DescribeConnectorProfiles
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectorProfilesAsync(
DescribeConnectorProfilesRequest 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.
*
*
* @param describeConnectorProfilesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectorProfiles operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DescribeConnectorProfiles
* @see AWS API Documentation
*/
java.util.concurrent.Future describeConnectorProfilesAsync(
DescribeConnectorProfilesRequest describeConnectorProfilesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param describeConnectorsRequest
* @return A Java Future containing the result of the DescribeConnectors operation returned by the service.
* @sample AmazonAppflowAsync.DescribeConnectors
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeConnectorsAsync(DescribeConnectorsRequest 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.
*
*
* @param describeConnectorsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeConnectors operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DescribeConnectors
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeConnectorsAsync(DescribeConnectorsRequest describeConnectorsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Provides a description of the specified flow.
*
*
* @param describeFlowRequest
* @return A Java Future containing the result of the DescribeFlow operation returned by the service.
* @sample AmazonAppflowAsync.DescribeFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeFlowAsync(DescribeFlowRequest describeFlowRequest);
/**
*
* Provides a description of the specified flow.
*
*
* @param describeFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.DescribeFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future describeFlowAsync(DescribeFlowRequest describeFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Fetches the execution history of the flow.
*
*
* @param describeFlowExecutionRecordsRequest
* @return A Java Future containing the result of the DescribeFlowExecutionRecords operation returned by the
* service.
* @sample AmazonAppflowAsync.DescribeFlowExecutionRecords
* @see AWS API Documentation
*/
java.util.concurrent.Future describeFlowExecutionRecordsAsync(
DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest);
/**
*
* Fetches the execution history of the flow.
*
*
* @param describeFlowExecutionRecordsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeFlowExecutionRecords operation returned by the
* service.
* @sample AmazonAppflowAsyncHandler.DescribeFlowExecutionRecords
* @see AWS API Documentation
*/
java.util.concurrent.Future describeFlowExecutionRecordsAsync(
DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listConnectorEntitiesRequest
* @return A Java Future containing the result of the ListConnectorEntities operation returned by the service.
* @sample AmazonAppflowAsync.ListConnectorEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listConnectorEntitiesAsync(ListConnectorEntitiesRequest 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.
*
*
* @param listConnectorEntitiesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListConnectorEntities operation returned by the service.
* @sample AmazonAppflowAsyncHandler.ListConnectorEntities
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listConnectorEntitiesAsync(ListConnectorEntitiesRequest listConnectorEntitiesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listConnectorsRequest
* @return A Java Future containing the result of the ListConnectors operation returned by the service.
* @sample AmazonAppflowAsync.ListConnectors
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listConnectorsAsync(ListConnectorsRequest 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.
*
*
* @param listConnectorsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListConnectors operation returned by the service.
* @sample AmazonAppflowAsyncHandler.ListConnectors
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listConnectorsAsync(ListConnectorsRequest listConnectorsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all of the flows associated with your account.
*
*
* @param listFlowsRequest
* @return A Java Future containing the result of the ListFlows operation returned by the service.
* @sample AmazonAppflowAsync.ListFlows
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFlowsAsync(ListFlowsRequest listFlowsRequest);
/**
*
* Lists all of the flows associated with your account.
*
*
* @param listFlowsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListFlows operation returned by the service.
* @sample AmazonAppflowAsyncHandler.ListFlows
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listFlowsAsync(ListFlowsRequest listFlowsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the tags that are associated with a specified flow.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonAppflowAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Retrieves the tags that are associated with a specified flow.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonAppflowAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param registerConnectorRequest
* @return A Java Future containing the result of the RegisterConnector operation returned by the service.
* @sample AmazonAppflowAsync.RegisterConnector
* @see AWS API
* Documentation
*/
java.util.concurrent.Future registerConnectorAsync(RegisterConnectorRequest 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.
*
*
* @param registerConnectorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RegisterConnector operation returned by the service.
* @sample AmazonAppflowAsyncHandler.RegisterConnector
* @see AWS API
* Documentation
*/
java.util.concurrent.Future registerConnectorAsync(RegisterConnectorRequest registerConnectorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param resetConnectorMetadataCacheRequest
* @return A Java Future containing the result of the ResetConnectorMetadataCache operation returned by the service.
* @sample AmazonAppflowAsync.ResetConnectorMetadataCache
* @see AWS API Documentation
*/
java.util.concurrent.Future resetConnectorMetadataCacheAsync(
ResetConnectorMetadataCacheRequest 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.
*
*
* @param resetConnectorMetadataCacheRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ResetConnectorMetadataCache operation returned by the service.
* @sample AmazonAppflowAsyncHandler.ResetConnectorMetadataCache
* @see AWS API Documentation
*/
java.util.concurrent.Future resetConnectorMetadataCacheAsync(
ResetConnectorMetadataCacheRequest resetConnectorMetadataCacheRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param startFlowRequest
* @return A Java Future containing the result of the StartFlow operation returned by the service.
* @sample AmazonAppflowAsync.StartFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startFlowAsync(StartFlowRequest 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.
*
*
* @param startFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.StartFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startFlowAsync(StartFlowRequest startFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param stopFlowRequest
* @return A Java Future containing the result of the StopFlow operation returned by the service.
* @sample AmazonAppflowAsync.StopFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopFlowAsync(StopFlowRequest 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.
*
*
* @param stopFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.StopFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopFlowAsync(StopFlowRequest stopFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Applies a tag to the specified flow.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonAppflowAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Applies a tag to the specified flow.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonAppflowAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Unregisters the custom connector registered in your account that matches the connector label provided in the
* request.
*
*
* @param unregisterConnectorRequest
* @return A Java Future containing the result of the UnregisterConnector operation returned by the service.
* @sample AmazonAppflowAsync.UnregisterConnector
* @see AWS
* API Documentation
*/
java.util.concurrent.Future unregisterConnectorAsync(UnregisterConnectorRequest unregisterConnectorRequest);
/**
*
* Unregisters the custom connector registered in your account that matches the connector label provided in the
* request.
*
*
* @param unregisterConnectorRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UnregisterConnector operation returned by the service.
* @sample AmazonAppflowAsyncHandler.UnregisterConnector
* @see AWS
* API Documentation
*/
java.util.concurrent.Future unregisterConnectorAsync(UnregisterConnectorRequest unregisterConnectorRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Removes a tag from the specified flow.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonAppflowAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Removes a tag from the specified flow.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonAppflowAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates a given connector profile associated with your account.
*
*
* @param updateConnectorProfileRequest
* @return A Java Future containing the result of the UpdateConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsync.UpdateConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateConnectorProfileAsync(UpdateConnectorProfileRequest updateConnectorProfileRequest);
/**
*
* Updates a given connector profile associated with your account.
*
*
* @param updateConnectorProfileRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateConnectorProfile operation returned by the service.
* @sample AmazonAppflowAsyncHandler.UpdateConnectorProfile
* @see AWS
* API Documentation
*/
java.util.concurrent.Future updateConnectorProfileAsync(UpdateConnectorProfileRequest updateConnectorProfileRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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
*
*
*
*
* @param updateConnectorRegistrationRequest
* @return A Java Future containing the result of the UpdateConnectorRegistration operation returned by the service.
* @sample AmazonAppflowAsync.UpdateConnectorRegistration
* @see AWS API Documentation
*/
java.util.concurrent.Future updateConnectorRegistrationAsync(
UpdateConnectorRegistrationRequest 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
*
*
*
*
* @param updateConnectorRegistrationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateConnectorRegistration operation returned by the service.
* @sample AmazonAppflowAsyncHandler.UpdateConnectorRegistration
* @see AWS API Documentation
*/
java.util.concurrent.Future updateConnectorRegistrationAsync(
UpdateConnectorRegistrationRequest updateConnectorRegistrationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates an existing flow.
*
*
* @param updateFlowRequest
* @return A Java Future containing the result of the UpdateFlow operation returned by the service.
* @sample AmazonAppflowAsync.UpdateFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateFlowAsync(UpdateFlowRequest updateFlowRequest);
/**
*
* Updates an existing flow.
*
*
* @param updateFlowRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateFlow operation returned by the service.
* @sample AmazonAppflowAsyncHandler.UpdateFlow
* @see AWS API
* Documentation
*/
java.util.concurrent.Future updateFlowAsync(UpdateFlowRequest updateFlowRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}