com.amazonaws.services.appflow

Interface AmazonAppflow

All Known Subinterfaces:

AmazonAppflowAsync

All Known Implementing Classes:

AbstractAmazonAppflow, AbstractAmazonAppflowAsync, AmazonAppflowAsyncClient, AmazonAppflowClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonAppflow

Interface for accessing Amazon Appflow.

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 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateConnectorProfileResult	createConnectorProfile(CreateConnectorProfileRequest createConnectorProfileRequest) Creates a new connector profile associated with your AWS 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.
DescribeConnectorEntityResult	describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest) Provides details regarding the entity used with the connector, with a description of the data model for each 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.
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.
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.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from the specified flow.
UpdateConnectorProfileResult	updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest) Updates a given connector profile associated with your account.
UpdateFlowResult	updateFlow(UpdateFlowRequest updateFlowRequest) Updates an existing flow.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createConnectorProfile

CreateConnectorProfileResult createConnectorProfile(CreateConnectorProfileRequest createConnectorProfileRequest)

Creates 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.

Parameters:

createConnectorProfileRequest -

Returns:

Result of the CreateConnectorProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createFlow

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.

Parameters:

createFlowRequest -

Returns:

Result of the CreateFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteConnectorProfile

DeleteConnectorProfileResult deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest)

Enables you to delete an existing connector profile.

Parameters:

deleteConnectorProfileRequest -

Returns:

Result of the DeleteConnectorProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteFlow

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.

Parameters:

deleteFlowRequest -

Returns:

Result of the DeleteFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeConnectorEntity

DescribeConnectorEntityResult describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest)

Provides details regarding the entity used with the connector, with a description of the data model for each entity.

Parameters:

describeConnectorEntityRequest -

Returns:

Result of the DescribeConnectorEntity operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeConnectorProfiles

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.

Parameters:

describeConnectorProfilesRequest -

Returns:

Result of the DescribeConnectorProfiles operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

InternalServerException - An internal service error occurred during the processing of your request. Try again later.

See Also:

AWS API Documentation

describeConnectors

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.

Parameters:

describeConnectorsRequest -

Returns:

Result of the DescribeConnectors operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

InternalServerException - An internal service error occurred during the processing of your request. Try again later.

See Also:

AWS API Documentation

describeFlow

DescribeFlowResult describeFlow(DescribeFlowRequest describeFlowRequest)

Provides a description of the specified flow.

Parameters:

describeFlowRequest -

Returns:

Result of the DescribeFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeFlowExecutionRecords

DescribeFlowExecutionRecordsResult describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)

Fetches the execution history of the flow.

Parameters:

describeFlowExecutionRecordsRequest -

Returns:

Result of the DescribeFlowExecutionRecords operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listConnectorEntities

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.

Parameters:

listConnectorEntitiesRequest -

Returns:

Result of the ListConnectorEntities operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listFlows

ListFlowsResult listFlows(ListFlowsRequest listFlowsRequest)

Lists all of the flows associated with your account.

Parameters:

listFlowsRequest -

Returns:

Result of the ListFlows operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

InternalServerException - An internal service error occurred during the processing of your request. Try again later.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Retrieves the tags that are associated with a specified flow.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startFlow

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.

Parameters:

startFlowRequest -

Returns:

Result of the StartFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

stopFlow

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.

Parameters:

stopFlowRequest -

Returns:

Result of the StopFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Applies a tag to the specified flow.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag from the specified flow.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateConnectorProfile

UpdateConnectorProfileResult updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest)

Updates a given connector profile associated with your account.

Parameters:

updateConnectorProfileRequest -

Returns:

Result of the UpdateConnectorProfile operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

updateFlow

UpdateFlowResult updateFlow(UpdateFlowRequest updateFlowRequest)

Updates an existing flow.

Parameters:

updateFlowRequest -

Returns:

Result of the UpdateFlow operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.