@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonAppflowAsyncClient extends AmazonAppflowClient implements AmazonAppflowAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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 AWS 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, createConnectorProfile, createFlow, deleteConnectorProfile, deleteFlow, describeConnectorEntity, describeConnectorProfiles, describeConnectors, describeFlow, describeFlowExecutionRecords, getCachedResponseMetadata, listConnectorEntities, listFlows, listTagsForResource, startFlow, stopFlow, tagResource, untagResource, updateConnectorProfile, updateFlowaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateConnectorProfile, createFlow, deleteConnectorProfile, deleteFlow, describeConnectorEntity, describeConnectorProfiles, describeConnectors, describeFlow, describeFlowExecutionRecords, getCachedResponseMetadata, listConnectorEntities, listFlows, listTagsForResource, startFlow, stopFlow, tagResource, untagResource, updateConnectorProfile, updateFlowpublic static AmazonAppflowAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateConnectorProfileResult> createConnectorProfileAsync(CreateConnectorProfileRequest request)
AmazonAppflowAsyncCreates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS 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.
createConnectorProfileAsync in interface AmazonAppflowAsyncpublic Future<CreateConnectorProfileResult> createConnectorProfileAsync(CreateConnectorProfileRequest request, AsyncHandler<CreateConnectorProfileRequest,CreateConnectorProfileResult> asyncHandler)
AmazonAppflowAsyncCreates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS 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.
createConnectorProfileAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<CreateFlowResult> createFlowAsync(CreateFlowRequest request)
AmazonAppflowAsyncEnables 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.
createFlowAsync in interface AmazonAppflowAsyncpublic Future<CreateFlowResult> createFlowAsync(CreateFlowRequest request, AsyncHandler<CreateFlowRequest,CreateFlowResult> asyncHandler)
AmazonAppflowAsyncEnables 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.
createFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DeleteConnectorProfileResult> deleteConnectorProfileAsync(DeleteConnectorProfileRequest request)
AmazonAppflowAsyncEnables you to delete an existing connector profile.
deleteConnectorProfileAsync in interface AmazonAppflowAsyncpublic Future<DeleteConnectorProfileResult> deleteConnectorProfileAsync(DeleteConnectorProfileRequest request, AsyncHandler<DeleteConnectorProfileRequest,DeleteConnectorProfileResult> asyncHandler)
AmazonAppflowAsyncEnables you to delete an existing connector profile.
deleteConnectorProfileAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DeleteFlowResult> deleteFlowAsync(DeleteFlowRequest request)
AmazonAppflowAsyncEnables 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.
deleteFlowAsync in interface AmazonAppflowAsyncpublic Future<DeleteFlowResult> deleteFlowAsync(DeleteFlowRequest request, AsyncHandler<DeleteFlowRequest,DeleteFlowResult> asyncHandler)
AmazonAppflowAsyncEnables 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.
deleteFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DescribeConnectorEntityResult> describeConnectorEntityAsync(DescribeConnectorEntityRequest request)
AmazonAppflowAsyncProvides details regarding the entity used with the connector, with a description of the data model for each entity.
describeConnectorEntityAsync in interface AmazonAppflowAsyncpublic Future<DescribeConnectorEntityResult> describeConnectorEntityAsync(DescribeConnectorEntityRequest request, AsyncHandler<DescribeConnectorEntityRequest,DescribeConnectorEntityResult> asyncHandler)
AmazonAppflowAsyncProvides details regarding the entity used with the connector, with a description of the data model for each entity.
describeConnectorEntityAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DescribeConnectorProfilesResult> describeConnectorProfilesAsync(DescribeConnectorProfilesRequest request)
AmazonAppflowAsync
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.
describeConnectorProfilesAsync in interface AmazonAppflowAsyncpublic Future<DescribeConnectorProfilesResult> describeConnectorProfilesAsync(DescribeConnectorProfilesRequest request, AsyncHandler<DescribeConnectorProfilesRequest,DescribeConnectorProfilesResult> asyncHandler)
AmazonAppflowAsync
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.
describeConnectorProfilesAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DescribeConnectorsResult> describeConnectorsAsync(DescribeConnectorsRequest request)
AmazonAppflowAsync
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.
describeConnectorsAsync in interface AmazonAppflowAsyncpublic Future<DescribeConnectorsResult> describeConnectorsAsync(DescribeConnectorsRequest request, AsyncHandler<DescribeConnectorsRequest,DescribeConnectorsResult> asyncHandler)
AmazonAppflowAsync
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.
describeConnectorsAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DescribeFlowResult> describeFlowAsync(DescribeFlowRequest request)
AmazonAppflowAsyncProvides a description of the specified flow.
describeFlowAsync in interface AmazonAppflowAsyncpublic Future<DescribeFlowResult> describeFlowAsync(DescribeFlowRequest request, AsyncHandler<DescribeFlowRequest,DescribeFlowResult> asyncHandler)
AmazonAppflowAsyncProvides a description of the specified flow.
describeFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<DescribeFlowExecutionRecordsResult> describeFlowExecutionRecordsAsync(DescribeFlowExecutionRecordsRequest request)
AmazonAppflowAsyncFetches the execution history of the flow.
describeFlowExecutionRecordsAsync in interface AmazonAppflowAsyncpublic Future<DescribeFlowExecutionRecordsResult> describeFlowExecutionRecordsAsync(DescribeFlowExecutionRecordsRequest request, AsyncHandler<DescribeFlowExecutionRecordsRequest,DescribeFlowExecutionRecordsResult> asyncHandler)
AmazonAppflowAsyncFetches the execution history of the flow.
describeFlowExecutionRecordsAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<ListConnectorEntitiesResult> listConnectorEntitiesAsync(ListConnectorEntitiesRequest request)
AmazonAppflowAsyncReturns 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.
listConnectorEntitiesAsync in interface AmazonAppflowAsyncpublic Future<ListConnectorEntitiesResult> listConnectorEntitiesAsync(ListConnectorEntitiesRequest request, AsyncHandler<ListConnectorEntitiesRequest,ListConnectorEntitiesResult> asyncHandler)
AmazonAppflowAsyncReturns 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.
listConnectorEntitiesAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<ListFlowsResult> listFlowsAsync(ListFlowsRequest request)
AmazonAppflowAsyncLists all of the flows associated with your account.
listFlowsAsync in interface AmazonAppflowAsyncpublic Future<ListFlowsResult> listFlowsAsync(ListFlowsRequest request, AsyncHandler<ListFlowsRequest,ListFlowsResult> asyncHandler)
AmazonAppflowAsyncLists all of the flows associated with your account.
listFlowsAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonAppflowAsyncRetrieves the tags that are associated with a specified flow.
listTagsForResourceAsync in interface AmazonAppflowAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonAppflowAsyncRetrieves the tags that are associated with a specified flow.
listTagsForResourceAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<StartFlowResult> startFlowAsync(StartFlowRequest request)
AmazonAppflowAsyncActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
startFlowAsync in interface AmazonAppflowAsyncpublic Future<StartFlowResult> startFlowAsync(StartFlowRequest request, AsyncHandler<StartFlowRequest,StartFlowResult> asyncHandler)
AmazonAppflowAsyncActivates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
startFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<StopFlowResult> stopFlowAsync(StopFlowRequest request)
AmazonAppflowAsync
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.
stopFlowAsync in interface AmazonAppflowAsyncpublic Future<StopFlowResult> stopFlowAsync(StopFlowRequest request, AsyncHandler<StopFlowRequest,StopFlowResult> asyncHandler)
AmazonAppflowAsync
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.
stopFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonAppflowAsyncApplies a tag to the specified flow.
tagResourceAsync in interface AmazonAppflowAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonAppflowAsyncApplies a tag to the specified flow.
tagResourceAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonAppflowAsyncRemoves a tag from the specified flow.
untagResourceAsync in interface AmazonAppflowAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonAppflowAsyncRemoves a tag from the specified flow.
untagResourceAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<UpdateConnectorProfileResult> updateConnectorProfileAsync(UpdateConnectorProfileRequest request)
AmazonAppflowAsyncUpdates a given connector profile associated with your account.
updateConnectorProfileAsync in interface AmazonAppflowAsyncpublic Future<UpdateConnectorProfileResult> updateConnectorProfileAsync(UpdateConnectorProfileRequest request, AsyncHandler<UpdateConnectorProfileRequest,UpdateConnectorProfileResult> asyncHandler)
AmazonAppflowAsyncUpdates a given connector profile associated with your account.
updateConnectorProfileAsync in interface AmazonAppflowAsyncasyncHandler - 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.public Future<UpdateFlowResult> updateFlowAsync(UpdateFlowRequest request)
AmazonAppflowAsyncUpdates an existing flow.
updateFlowAsync in interface AmazonAppflowAsyncpublic Future<UpdateFlowResult> updateFlowAsync(UpdateFlowRequest request, AsyncHandler<UpdateFlowRequest,UpdateFlowResult> asyncHandler)
AmazonAppflowAsyncUpdates an existing flow.
updateFlowAsync in interface AmazonAppflowAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonAppflowshutdown in class AmazonAppflowClient