@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonAppflow
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonAppflow 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CancelFlowExecutionsResult |
cancelFlowExecutions (CancelFlowExecutionsRequest cancelFlowExecutionsRequest)
Cancels active runs for a flow.
|
CreateConnectorProfileResult |
createConnectorProfile (CreateConnectorProfileRequest createConnectorProfileRequest)
Creates a new connector profile associated with your Amazon Web Services account.
|
CreateFlowResult |
createFlow (CreateFlowRequest createFlowRequest)
Enables your application to create a new flow using Amazon AppFlow.
|
DeleteConnectorProfileResult |
deleteConnectorProfile (DeleteConnectorProfileRequest deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
|
DeleteFlowResult |
deleteFlow (DeleteFlowRequest deleteFlowRequest)
Enables your application to delete an existing flow.
|
DescribeConnectorResult |
describeConnector (DescribeConnectorRequest describeConnectorRequest)
Describes the given custom connector registered in your Amazon Web Services account.
|
DescribeConnectorEntityResult |
describeConnectorEntity (DescribeConnectorEntityRequest describeConnectorEntityRequest)
Provides details regarding the entity used with the connector, with a description of the data model for each
field in that entity.
|
DescribeConnectorProfilesResult |
describeConnectorProfiles (DescribeConnectorProfilesRequest describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
DescribeConnectorsResult |
describeConnectors (DescribeConnectorsRequest describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
DescribeFlowResult |
describeFlow (DescribeFlowRequest describeFlowRequest)
Provides a description of the specified flow.
|
DescribeFlowExecutionRecordsResult |
describeFlowExecutionRecords (DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
ResponseMetadata |
getCachedResponseMetadata (AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListConnectorEntitiesResult |
listConnectorEntities (ListConnectorEntitiesRequest listConnectorEntitiesRequest)
Returns the list of available connector entities supported by Amazon AppFlow.
|
ListConnectorsResult |
listConnectors (ListConnectorsRequest listConnectorsRequest)
Returns the list of all registered custom connectors in your Amazon Web Services account.
|
ListFlowsResult |
listFlows (ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
|
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
|
RegisterConnectorResult |
registerConnector (RegisterConnectorRequest registerConnectorRequest)
Registers a new custom connector with your Amazon Web Services account.
|
ResetConnectorMetadataCacheResult |
resetConnectorMetadataCache (ResetConnectorMetadataCacheRequest resetConnectorMetadataCacheRequest)
Resets metadata about your connector entities that Amazon AppFlow stored in its cache.
|
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held open.
|
StartFlowResult |
startFlow (StartFlowRequest startFlowRequest)
Activates an existing flow.
|
StopFlowResult |
stopFlow (StopFlowRequest stopFlowRequest)
Deactivates the existing flow.
|
TagResourceResult |
tagResource (TagResourceRequest tagResourceRequest)
Applies a tag to the specified flow.
|
UnregisterConnectorResult |
unregisterConnector (UnregisterConnectorRequest unregisterConnectorRequest)
Unregisters the custom connector registered in your account that matches the connector label provided in the
request.
|
UntagResourceResult |
untagResource (UntagResourceRequest untagResourceRequest)
Removes a tag from the specified flow.
|
UpdateConnectorProfileResult |
updateConnectorProfile (UpdateConnectorProfileRequest updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
|
UpdateConnectorRegistrationResult |
updateConnectorRegistration (UpdateConnectorRegistrationRequest updateConnectorRegistrationRequest)
Updates a custom connector that you've previously registered.
|
UpdateFlowResult |
updateFlow (UpdateFlowRequest updateFlowRequest)
Updates an existing flow.
|
static final String ENDPOINT_PREFIX
CancelFlowExecutionsResult cancelFlowExecutions(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.
cancelFlowExecutionsRequest - ValidationException - The request has invalid or missing parameters.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.CreateConnectorProfileResult createConnectorProfile(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.
createConnectorProfileRequest - ValidationException - The request has invalid or missing parameters.ConflictException - 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.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.CreateFlowResult createFlow(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 - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - 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.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.DeleteConnectorProfileResult deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
deleteConnectorProfileRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - 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.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DeleteFlowResult deleteFlow(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 - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - 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.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DescribeConnectorResult describeConnector(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.
describeConnectorRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.DescribeConnectorEntityResult describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest)
Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
describeConnectorEntityRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DescribeConnectorProfilesResult describeConnectorProfiles(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 - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DescribeConnectorsResult describeConnectors(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 - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DescribeFlowResult describeFlow(DescribeFlowRequest describeFlowRequest)
Provides a description of the specified flow.
describeFlowRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.DescribeFlowExecutionRecordsResult describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
describeFlowExecutionRecordsRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ListConnectorEntitiesResult listConnectorEntities(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 - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ListConnectorsResult listConnectors(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.
listConnectorsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ListFlowsResult listFlows(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
listFlowsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
listTagsForResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.RegisterConnectorResult registerConnector(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.
registerConnectorRequest - ValidationException - The request has invalid or missing parameters.ConflictException - 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.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ResetConnectorMetadataCacheResult resetConnectorMetadataCache(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.
resetConnectorMetadataCacheRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - 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.InternalServerException - An internal service error occurred during the processing of your request. Try again later.StartFlowResult startFlow(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 - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - 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.StopFlowResult stopFlow(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 - ConflictException - 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.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.UnsupportedOperationException - The requested operation is not supported for the current flow.InternalServerException - An internal service error occurred during the processing of your request. Try again later.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to the specified flow.
tagResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.UnregisterConnectorResult unregisterConnector(UnregisterConnectorRequest unregisterConnectorRequest)
Unregisters the custom connector registered in your account that matches the connector label provided in the request.
unregisterConnectorRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - 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.InternalServerException - An internal service error occurred during the processing of your request. Try again later.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified flow.
untagResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.UpdateConnectorProfileResult updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
updateConnectorProfileRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - 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.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.UpdateConnectorRegistrationResult updateConnectorRegistration(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
updateConnectorRegistrationRequest - ValidationException - The request has invalid or missing parameters.ConflictException - 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.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.UpdateFlowResult updateFlow(UpdateFlowRequest updateFlowRequest)
Updates an existing flow.
updateFlowRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - 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.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.