com.amazonaws.services.appflow

Class AmazonAppflowClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appflow.AmazonAppflowClient

All Implemented Interfaces:

AmazonAppflow

Direct Known Subclasses:

AmazonAppflowAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonAppflowClient
extends AmazonWebServiceClient
implements AmazonAppflow

Client for accessing Amazon Appflow. All service calls made using this client are blocking, and will not return until the service call 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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.appflow.AmazonAppflow

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonAppflowClientBuilder	builder()
CreateConnectorProfileResult	createConnectorProfile(CreateConnectorProfileRequest request) Creates a new connector profile associated with your AWS account.
CreateFlowResult	createFlow(CreateFlowRequest request) Enables your application to create a new flow using Amazon AppFlow.
DeleteConnectorProfileResult	deleteConnectorProfile(DeleteConnectorProfileRequest request) Enables you to delete an existing connector profile.
DeleteFlowResult	deleteFlow(DeleteFlowRequest request) Enables your application to delete an existing flow.
DescribeConnectorEntityResult	describeConnectorEntity(DescribeConnectorEntityRequest request) Provides details regarding the entity used with the connector, with a description of the data model for each entity.
DescribeConnectorProfilesResult	describeConnectorProfiles(DescribeConnectorProfilesRequest request) Returns a list of connector-profile details matching the provided connector-profile names and connector-types.
DescribeConnectorsResult	describeConnectors(DescribeConnectorsRequest request) Describes the connectors vended by Amazon AppFlow for specified connector types.
DescribeFlowResult	describeFlow(DescribeFlowRequest request) Provides a description of the specified flow.
DescribeFlowExecutionRecordsResult	describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest request) 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 request) Returns the list of available connector entities supported by Amazon AppFlow.
ListFlowsResult	listFlows(ListFlowsRequest request) Lists all of the flows associated with your account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) 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 request) Activates an existing flow.
StopFlowResult	stopFlow(StopFlowRequest request) Deactivates the existing flow.
TagResourceResult	tagResource(TagResourceRequest request) Applies a tag to the specified flow.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from the specified flow.
UpdateConnectorProfileResult	updateConnectorProfile(UpdateConnectorProfileRequest request) Updates a given connector profile associated with your account.
UpdateFlowResult	updateFlow(UpdateFlowRequest request) Updates an existing flow.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonAppflowClientBuilder builder()

createConnectorProfile

public CreateConnectorProfileResult createConnectorProfile(CreateConnectorProfileRequest request)

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.

Specified by:

createConnectorProfile in interface AmazonAppflow

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

public CreateFlowResult createFlow(CreateFlowRequest request)

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.

Specified by:

createFlow in interface AmazonAppflow

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

public DeleteConnectorProfileResult deleteConnectorProfile(DeleteConnectorProfileRequest request)

Enables you to delete an existing connector profile.

Specified by:

deleteConnectorProfile in interface AmazonAppflow

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

public DeleteFlowResult deleteFlow(DeleteFlowRequest request)

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.

Specified by:

deleteFlow in interface AmazonAppflow

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

public DescribeConnectorEntityResult describeConnectorEntity(DescribeConnectorEntityRequest request)

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

Specified by:

describeConnectorEntity in interface AmazonAppflow

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

public DescribeConnectorProfilesResult describeConnectorProfiles(DescribeConnectorProfilesRequest request)

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.

Specified by:

describeConnectorProfiles in interface AmazonAppflow

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

public DescribeConnectorsResult describeConnectors(DescribeConnectorsRequest request)

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.

Specified by:

describeConnectors in interface AmazonAppflow

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

public DescribeFlowResult describeFlow(DescribeFlowRequest request)

Provides a description of the specified flow.

Specified by:

describeFlow in interface AmazonAppflow

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

public DescribeFlowExecutionRecordsResult describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest request)

Fetches the execution history of the flow.

Specified by:

describeFlowExecutionRecords in interface AmazonAppflow

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

public ListConnectorEntitiesResult listConnectorEntities(ListConnectorEntitiesRequest request)

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.

Specified by:

listConnectorEntities in interface AmazonAppflow

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

public ListFlowsResult listFlows(ListFlowsRequest request)

Lists all of the flows associated with your account.

Specified by:

listFlows in interface AmazonAppflow

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Retrieves the tags that are associated with a specified flow.

Specified by:

listTagsForResource in interface AmazonAppflow

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

public StartFlowResult startFlow(StartFlowRequest request)

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.

Specified by:

startFlow in interface AmazonAppflow

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

public StopFlowResult stopFlow(StopFlowRequest request)

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.

Specified by:

stopFlow in interface AmazonAppflow

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

public TagResourceResult tagResource(TagResourceRequest request)

Applies a tag to the specified flow.

Specified by:

tagResource in interface AmazonAppflow

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from the specified flow.

Specified by:

untagResource in interface AmazonAppflow

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

public UpdateConnectorProfileResult updateConnectorProfile(UpdateConnectorProfileRequest request)

Updates a given connector profile associated with your account.

Specified by:

updateConnectorProfile in interface AmazonAppflow

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

public UpdateFlowResult updateFlow(UpdateFlowRequest request)

Updates an existing flow.

Specified by:

updateFlow in interface AmazonAppflow

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonAppflow

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonAppflow

Overrides:

shutdown in class AmazonWebServiceClient