@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAppflowAsync extends AmazonAppflow
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
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.
ENDPOINT_PREFIXcreateConnectorProfile, createFlow, deleteConnectorProfile, deleteFlow, describeConnectorEntity, describeConnectorProfiles, describeConnectors, describeFlow, describeFlowExecutionRecords, getCachedResponseMetadata, listConnectorEntities, listFlows, listTagsForResource, shutdown, startFlow, stopFlow, tagResource, untagResource, updateConnectorProfile, updateFlowFuture<CreateConnectorProfileResult> 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.
createConnectorProfileRequest - Future<CreateConnectorProfileResult> createConnectorProfileAsync(CreateConnectorProfileRequest createConnectorProfileRequest, AsyncHandler<CreateConnectorProfileRequest,CreateConnectorProfileResult> 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.
createConnectorProfileRequest - 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.Future<CreateFlowResult> 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.
createFlowRequest - Future<CreateFlowResult> createFlowAsync(CreateFlowRequest createFlowRequest, AsyncHandler<CreateFlowRequest,CreateFlowResult> 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.
createFlowRequest - 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.Future<DeleteConnectorProfileResult> deleteConnectorProfileAsync(DeleteConnectorProfileRequest deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
deleteConnectorProfileRequest - Future<DeleteConnectorProfileResult> deleteConnectorProfileAsync(DeleteConnectorProfileRequest deleteConnectorProfileRequest, AsyncHandler<DeleteConnectorProfileRequest,DeleteConnectorProfileResult> asyncHandler)
Enables you to delete an existing connector profile.
deleteConnectorProfileRequest - 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.Future<DeleteFlowResult> 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.
deleteFlowRequest - Future<DeleteFlowResult> deleteFlowAsync(DeleteFlowRequest deleteFlowRequest, AsyncHandler<DeleteFlowRequest,DeleteFlowResult> 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.
deleteFlowRequest - 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.Future<DescribeConnectorEntityResult> describeConnectorEntityAsync(DescribeConnectorEntityRequest describeConnectorEntityRequest)
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
describeConnectorEntityRequest - Future<DescribeConnectorEntityResult> describeConnectorEntityAsync(DescribeConnectorEntityRequest describeConnectorEntityRequest, AsyncHandler<DescribeConnectorEntityRequest,DescribeConnectorEntityResult> asyncHandler)
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
describeConnectorEntityRequest - 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.Future<DescribeConnectorProfilesResult> 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.
describeConnectorProfilesRequest - Future<DescribeConnectorProfilesResult> describeConnectorProfilesAsync(DescribeConnectorProfilesRequest describeConnectorProfilesRequest, AsyncHandler<DescribeConnectorProfilesRequest,DescribeConnectorProfilesResult> 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.
describeConnectorProfilesRequest - 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.Future<DescribeConnectorsResult> 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.
describeConnectorsRequest - Future<DescribeConnectorsResult> describeConnectorsAsync(DescribeConnectorsRequest describeConnectorsRequest, AsyncHandler<DescribeConnectorsRequest,DescribeConnectorsResult> 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.
describeConnectorsRequest - 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.Future<DescribeFlowResult> describeFlowAsync(DescribeFlowRequest describeFlowRequest)
Provides a description of the specified flow.
describeFlowRequest - Future<DescribeFlowResult> describeFlowAsync(DescribeFlowRequest describeFlowRequest, AsyncHandler<DescribeFlowRequest,DescribeFlowResult> asyncHandler)
Provides a description of the specified flow.
describeFlowRequest - 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.Future<DescribeFlowExecutionRecordsResult> describeFlowExecutionRecordsAsync(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
describeFlowExecutionRecordsRequest - Future<DescribeFlowExecutionRecordsResult> describeFlowExecutionRecordsAsync(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest, AsyncHandler<DescribeFlowExecutionRecordsRequest,DescribeFlowExecutionRecordsResult> asyncHandler)
Fetches the execution history of the flow.
describeFlowExecutionRecordsRequest - 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.Future<ListConnectorEntitiesResult> 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.
listConnectorEntitiesRequest - Future<ListConnectorEntitiesResult> listConnectorEntitiesAsync(ListConnectorEntitiesRequest listConnectorEntitiesRequest, AsyncHandler<ListConnectorEntitiesRequest,ListConnectorEntitiesResult> 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.
listConnectorEntitiesRequest - 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.Future<ListFlowsResult> listFlowsAsync(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
listFlowsRequest - Future<ListFlowsResult> listFlowsAsync(ListFlowsRequest listFlowsRequest, AsyncHandler<ListFlowsRequest,ListFlowsResult> asyncHandler)
Lists all of the flows associated with your account.
listFlowsRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Retrieves the tags that are associated with a specified flow.
listTagsForResourceRequest - 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.Future<StartFlowResult> 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.
startFlowRequest - Future<StartFlowResult> startFlowAsync(StartFlowRequest startFlowRequest, AsyncHandler<StartFlowRequest,StartFlowResult> 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.
startFlowRequest - 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.Future<StopFlowResult> 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.
stopFlowRequest - Future<StopFlowResult> stopFlowAsync(StopFlowRequest stopFlowRequest, AsyncHandler<StopFlowRequest,StopFlowResult> 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.
stopFlowRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Applies a tag to the specified flow.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Applies a tag to the specified flow.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified flow.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a tag from the specified flow.
untagResourceRequest - 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.Future<UpdateConnectorProfileResult> updateConnectorProfileAsync(UpdateConnectorProfileRequest updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
updateConnectorProfileRequest - Future<UpdateConnectorProfileResult> updateConnectorProfileAsync(UpdateConnectorProfileRequest updateConnectorProfileRequest, AsyncHandler<UpdateConnectorProfileRequest,UpdateConnectorProfileResult> asyncHandler)
Updates a given connector profile associated with your account.
updateConnectorProfileRequest - 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.Future<UpdateFlowResult> updateFlowAsync(UpdateFlowRequest updateFlowRequest)
Updates an existing flow.
updateFlowRequest - Future<UpdateFlowResult> updateFlowAsync(UpdateFlowRequest updateFlowRequest, AsyncHandler<UpdateFlowRequest,UpdateFlowResult> asyncHandler)
Updates an existing flow.
updateFlowRequest - 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.