AmazonAppflowClient (AWS Java SDK for Amazon Appflow 1.12.618 API)

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

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.appflow.AmazonAppflow
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonAppflowClientBuilder`	`builder()`
`CancelFlowExecutionsResult`	`cancelFlowExecutions(CancelFlowExecutionsRequest request)` Cancels active runs for a flow.
`CreateConnectorProfileResult`	`createConnectorProfile(CreateConnectorProfileRequest request)` Creates a new connector profile associated with your Amazon Web Services 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.
`DescribeConnectorResult`	`describeConnector(DescribeConnectorRequest request)` Describes the given custom connector registered in your Amazon Web Services account.
`DescribeConnectorEntityResult`	`describeConnectorEntity(DescribeConnectorEntityRequest request)` 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 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.
`ListConnectorsResult`	`listConnectors(ListConnectorsRequest request)` Returns the list of all registered custom connectors in your Amazon Web Services account.
`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.
`RegisterConnectorResult`	`registerConnector(RegisterConnectorRequest request)` Registers a new custom connector with your Amazon Web Services account.
`ResetConnectorMetadataCacheResult`	`resetConnectorMetadataCache(ResetConnectorMetadataCacheRequest request)` 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 request)` Activates an existing flow.
`StopFlowResult`	`stopFlow(StopFlowRequest request)` Deactivates the existing flow.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies a tag to the specified flow.
`UnregisterConnectorResult`	`unregisterConnector(UnregisterConnectorRequest request)` Unregisters the custom connector registered in your account that matches the connector label provided in the request.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from the specified flow.
`UpdateConnectorProfileResult`	`updateConnectorProfile(UpdateConnectorProfileRequest request)` Updates a given connector profile associated with your account.
`UpdateConnectorRegistrationResult`	`updateConnectorRegistration(UpdateConnectorRegistrationRequest request)` Updates a custom connector that you've previously registered.
`UpdateFlowResult`	`updateFlow(UpdateFlowRequest request)` Updates an existing flow.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonAppflowClientBuilder builder()
```
  - cancelFlowExecutions
```
public CancelFlowExecutionsResult cancelFlowExecutions(CancelFlowExecutionsRequest request)
```
    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.
    
    Specified by:
    
    cancelFlowExecutions in interface AmazonAppflow
    
    Parameters:
    
    cancelFlowExecutionsRequest -
    
    Returns:
    
    Result of the CancelFlowExecutions operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createConnectorProfile
```
public CreateConnectorProfileResult createConnectorProfile(CreateConnectorProfileRequest request)
```
    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.
    
    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.
    
    AccessDeniedException - AppFlow/Requester has invalid or missing permissions.
    
    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
  - describeConnector
```
public DescribeConnectorResult describeConnector(DescribeConnectorRequest request)
```
    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.
    
    Specified by:
    
    describeConnector in interface AmazonAppflow
    
    Parameters:
    
    describeConnectorRequest -
    
    Returns:
    
    Result of the DescribeConnector 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.
    
    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 field in that 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
  - listConnectors
```
public ListConnectorsResult listConnectors(ListConnectorsRequest request)
```
    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.
    
    Specified by:
    
    listConnectors in interface AmazonAppflow
    
    Parameters:
    
    listConnectorsRequest -
    
    Returns:
    
    Result of the ListConnectors 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
  - 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
  - registerConnector
```
public RegisterConnectorResult registerConnector(RegisterConnectorRequest request)
```
    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.
    
    Specified by:
    
    registerConnector in interface AmazonAppflow
    
    Parameters:
    
    registerConnectorRequest -
    
    Returns:
    
    Result of the RegisterConnector 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.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - resetConnectorMetadataCache
```
public ResetConnectorMetadataCacheResult resetConnectorMetadataCache(ResetConnectorMetadataCacheRequest request)
```
    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.
    
    Specified by:
    
    resetConnectorMetadataCache in interface AmazonAppflow
    
    Parameters:
    
    resetConnectorMetadataCacheRequest -
    
    Returns:
    
    Result of the ResetConnectorMetadataCache 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.
    
    InternalServerException - An internal service error occurred during the processing of your request. Try again later.
    
    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
  - unregisterConnector
```
public UnregisterConnectorResult unregisterConnector(UnregisterConnectorRequest request)
```
    Unregisters the custom connector registered in your account that matches the connector label provided in the request.
    
    Specified by:
    
    unregisterConnector in interface AmazonAppflow
    
    Parameters:
    
    unregisterConnectorRequest -
    
    Returns:
    
    Result of the UnregisterConnector 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
  - 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
  - updateConnectorRegistration
```
public UpdateConnectorRegistrationResult updateConnectorRegistration(UpdateConnectorRegistrationRequest request)
```
    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
    Specified by:
    
    updateConnectorRegistration in interface AmazonAppflow
    
    Parameters:
    
    updateConnectorRegistrationRequest -
    
    Returns:
    
    Result of the UpdateConnectorRegistration 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.
    
    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.
    
    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.
    
    AccessDeniedException - AppFlow/Requester has invalid or missing permissions.
    
    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 interface: AmazonAppflow
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonAppflow
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonAppflowClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

cancelFlowExecutions

createConnectorProfile

createFlow

deleteConnectorProfile

deleteFlow

describeConnector

describeConnectorEntity

describeConnectorProfiles

describeConnectors

describeFlow

describeFlowExecutionRecords

listConnectorEntities

listConnectors

listFlows

listTagsForResource

registerConnector

resetConnectorMetadataCache

startFlow

stopFlow

tagResource

unregisterConnector

untagResource

updateConnectorProfile

updateConnectorRegistration

updateFlow

getCachedResponseMetadata

shutdown