Package software.amazon.awssdk.services.appflow

Interface AppflowAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AppflowAsyncClient extends AwsClient
Service client for accessing Amazon Appflow asynchronously. This can be created using the static builder() method.

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 Details

  • Method Details

    • cancelFlowExecutions

      default CompletableFuture<CancelFlowExecutionsResponse> 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.

      Parameters:
      cancelFlowExecutionsRequest -
      Returns:
      A Java Future containing the result of the CancelFlowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelFlowExecutions

      default CompletableFuture<CancelFlowExecutionsResponse> cancelFlowExecutions(Consumer<CancelFlowExecutionsRequest.Builder> 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.


      This is a convenience which creates an instance of the CancelFlowExecutionsRequest.Builder avoiding the need to create one manually via CancelFlowExecutionsRequest.builder()

      Parameters:
      cancelFlowExecutionsRequest - A Consumer that will call methods on CancelFlowExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelFlowExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectorProfile

      default CompletableFuture<CreateConnectorProfileResponse> 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.

      Parameters:
      createConnectorProfileRequest -
      Returns:
      A Java Future containing the result of the CreateConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createConnectorProfile

      default CompletableFuture<CreateConnectorProfileResponse> createConnectorProfile(Consumer<CreateConnectorProfileRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateConnectorProfileRequest.Builder avoiding the need to create one manually via CreateConnectorProfileRequest.builder()

      Parameters:
      createConnectorProfileRequest - A Consumer that will call methods on CreateConnectorProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlow

      default CompletableFuture<CreateFlowResponse> 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:
      A Java Future containing the result of the CreateFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createFlow

      default CompletableFuture<CreateFlowResponse> createFlow(Consumer<CreateFlowRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateFlowRequest.Builder avoiding the need to create one manually via CreateFlowRequest.builder()

      Parameters:
      createFlowRequest - A Consumer that will call methods on CreateFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectorProfile

      default CompletableFuture<DeleteConnectorProfileResponse> deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest)

      Enables you to delete an existing connector profile.

      Parameters:
      deleteConnectorProfileRequest -
      Returns:
      A Java Future containing the result of the DeleteConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteConnectorProfile

      default CompletableFuture<DeleteConnectorProfileResponse> deleteConnectorProfile(Consumer<DeleteConnectorProfileRequest.Builder> deleteConnectorProfileRequest)

      Enables you to delete an existing connector profile.


      This is a convenience which creates an instance of the DeleteConnectorProfileRequest.Builder avoiding the need to create one manually via DeleteConnectorProfileRequest.builder()

      Parameters:
      deleteConnectorProfileRequest - A Consumer that will call methods on DeleteConnectorProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlow

      default CompletableFuture<DeleteFlowResponse> 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:
      A Java Future containing the result of the DeleteFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteFlow

      default CompletableFuture<DeleteFlowResponse> deleteFlow(Consumer<DeleteFlowRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteFlowRequest.Builder avoiding the need to create one manually via DeleteFlowRequest.builder()

      Parameters:
      deleteFlowRequest - A Consumer that will call methods on DeleteFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnector

      default CompletableFuture<DescribeConnectorResponse> 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.

      Parameters:
      describeConnectorRequest -
      Returns:
      A Java Future containing the result of the DescribeConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnector

      default CompletableFuture<DescribeConnectorResponse> describeConnector(Consumer<DescribeConnectorRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeConnectorRequest.Builder avoiding the need to create one manually via DescribeConnectorRequest.builder()

      Parameters:
      describeConnectorRequest - A Consumer that will call methods on DescribeConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorEntity

      default CompletableFuture<DescribeConnectorEntityResponse> 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.

      Parameters:
      describeConnectorEntityRequest -
      Returns:
      A Java Future containing the result of the DescribeConnectorEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorEntity

      default CompletableFuture<DescribeConnectorEntityResponse> describeConnectorEntity(Consumer<DescribeConnectorEntityRequest.Builder> describeConnectorEntityRequest)

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


      This is a convenience which creates an instance of the DescribeConnectorEntityRequest.Builder avoiding the need to create one manually via DescribeConnectorEntityRequest.builder()

      Parameters:
      describeConnectorEntityRequest - A Consumer that will call methods on DescribeConnectorEntityRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectorEntity operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorProfiles

      default CompletableFuture<DescribeConnectorProfilesResponse> 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:
      A Java Future containing the result of the DescribeConnectorProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorProfiles

      default CompletableFuture<DescribeConnectorProfilesResponse> describeConnectorProfiles(Consumer<DescribeConnectorProfilesRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeConnectorProfilesRequest.Builder avoiding the need to create one manually via DescribeConnectorProfilesRequest.builder()

      Parameters:
      describeConnectorProfilesRequest - A Consumer that will call methods on DescribeConnectorProfilesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectorProfiles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorProfilesPaginator

      default DescribeConnectorProfilesPublisher describeConnectorProfilesPaginator(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.


      This is a variant of describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesPublisher publisher = client.describeConnectorProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesPublisher publisher = client.describeConnectorProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest) operation.

      Parameters:
      describeConnectorProfilesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorProfilesPaginator

      default DescribeConnectorProfilesPublisher describeConnectorProfilesPaginator(Consumer<DescribeConnectorProfilesRequest.Builder> 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.


      This is a variant of describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesPublisher publisher = client.describeConnectorProfilesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesPublisher publisher = client.describeConnectorProfilesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest) operation.

      This is a convenience which creates an instance of the DescribeConnectorProfilesRequest.Builder avoiding the need to create one manually via DescribeConnectorProfilesRequest.builder()

      Parameters:
      describeConnectorProfilesRequest - A Consumer that will call methods on DescribeConnectorProfilesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectors

      default CompletableFuture<DescribeConnectorsResponse> 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:
      A Java Future containing the result of the DescribeConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectors

      default CompletableFuture<DescribeConnectorsResponse> describeConnectors(Consumer<DescribeConnectorsRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeConnectorsRequest.Builder avoiding the need to create one manually via DescribeConnectorsRequest.builder()

      Parameters:
      describeConnectorsRequest - A Consumer that will call methods on DescribeConnectorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorsPaginator

      default DescribeConnectorsPublisher describeConnectorsPaginator(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.


      This is a variant of describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsPublisher publisher = client.describeConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsPublisher publisher = client.describeConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest) operation.

      Parameters:
      describeConnectorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeConnectorsPaginator

      default DescribeConnectorsPublisher describeConnectorsPaginator(Consumer<DescribeConnectorsRequest.Builder> 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.


      This is a variant of describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsPublisher publisher = client.describeConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsPublisher publisher = client.describeConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest) operation.

      This is a convenience which creates an instance of the DescribeConnectorsRequest.Builder avoiding the need to create one manually via DescribeConnectorsRequest.builder()

      Parameters:
      describeConnectorsRequest - A Consumer that will call methods on DescribeConnectorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlow

      default CompletableFuture<DescribeFlowResponse> describeFlow(DescribeFlowRequest describeFlowRequest)

      Provides a description of the specified flow.

      Parameters:
      describeFlowRequest -
      Returns:
      A Java Future containing the result of the DescribeFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlow

      default CompletableFuture<DescribeFlowResponse> describeFlow(Consumer<DescribeFlowRequest.Builder> describeFlowRequest)

      Provides a description of the specified flow.


      This is a convenience which creates an instance of the DescribeFlowRequest.Builder avoiding the need to create one manually via DescribeFlowRequest.builder()

      Parameters:
      describeFlowRequest - A Consumer that will call methods on DescribeFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowExecutionRecords

      default CompletableFuture<DescribeFlowExecutionRecordsResponse> describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)

      Fetches the execution history of the flow.

      Parameters:
      describeFlowExecutionRecordsRequest -
      Returns:
      A Java Future containing the result of the DescribeFlowExecutionRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowExecutionRecords

      default CompletableFuture<DescribeFlowExecutionRecordsResponse> describeFlowExecutionRecords(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)

      Fetches the execution history of the flow.


      This is a convenience which creates an instance of the DescribeFlowExecutionRecordsRequest.Builder avoiding the need to create one manually via DescribeFlowExecutionRecordsRequest.builder()

      Parameters:
      describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeFlowExecutionRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowExecutionRecordsPaginator

      default DescribeFlowExecutionRecordsPublisher describeFlowExecutionRecordsPaginator(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)

      Fetches the execution history of the flow.


      This is a variant of describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsPublisher publisher = client.describeFlowExecutionRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsPublisher publisher = client.describeFlowExecutionRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest) operation.

      Parameters:
      describeFlowExecutionRecordsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeFlowExecutionRecordsPaginator

      default DescribeFlowExecutionRecordsPublisher describeFlowExecutionRecordsPaginator(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)

      Fetches the execution history of the flow.


      This is a variant of describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsPublisher publisher = client.describeFlowExecutionRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsPublisher publisher = client.describeFlowExecutionRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest) operation.

      This is a convenience which creates an instance of the DescribeFlowExecutionRecordsRequest.Builder avoiding the need to create one manually via DescribeFlowExecutionRecordsRequest.builder()

      Parameters:
      describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectorEntities

      default CompletableFuture<ListConnectorEntitiesResponse> 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:
      A Java Future containing the result of the ListConnectorEntities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectorEntities

      default CompletableFuture<ListConnectorEntitiesResponse> listConnectorEntities(Consumer<ListConnectorEntitiesRequest.Builder> 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.


      This is a convenience which creates an instance of the ListConnectorEntitiesRequest.Builder avoiding the need to create one manually via ListConnectorEntitiesRequest.builder()

      Parameters:
      listConnectorEntitiesRequest - A Consumer that will call methods on ListConnectorEntitiesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListConnectorEntities operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectors

      default CompletableFuture<ListConnectorsResponse> 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.

      Parameters:
      listConnectorsRequest -
      Returns:
      A Java Future containing the result of the ListConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectors

      default CompletableFuture<ListConnectorsResponse> listConnectors(Consumer<ListConnectorsRequest.Builder> 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.


      This is a convenience which creates an instance of the ListConnectorsRequest.Builder avoiding the need to create one manually via ListConnectorsRequest.builder()

      Parameters:
      listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListConnectors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectorsPaginator

      default ListConnectorsPublisher listConnectorsPaginator(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.


      This is a variant of listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.ListConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.ListConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest) operation.

      Parameters:
      listConnectorsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listConnectorsPaginator

      default ListConnectorsPublisher listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> 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.


      This is a variant of listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.ListConnectorsPublisher publisher = client.listConnectorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.ListConnectorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.ListConnectorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest) operation.

      This is a convenience which creates an instance of the ListConnectorsRequest.Builder avoiding the need to create one manually via ListConnectorsRequest.builder()

      Parameters:
      listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlows

      default CompletableFuture<ListFlowsResponse> listFlows(ListFlowsRequest listFlowsRequest)

      Lists all of the flows associated with your account.

      Parameters:
      listFlowsRequest -
      Returns:
      A Java Future containing the result of the ListFlows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlows

      default CompletableFuture<ListFlowsResponse> listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest)

      Lists all of the flows associated with your account.


      This is a convenience which creates an instance of the ListFlowsRequest.Builder avoiding the need to create one manually via ListFlowsRequest.builder()

      Parameters:
      listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListFlows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowsPaginator

      default ListFlowsPublisher listFlowsPaginator(ListFlowsRequest listFlowsRequest)

      Lists all of the flows associated with your account.


      This is a variant of listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.ListFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.ListFlowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest) operation.

      Parameters:
      listFlowsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listFlowsPaginator

      default ListFlowsPublisher listFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest)

      Lists all of the flows associated with your account.


      This is a variant of listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.appflow.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.appflow.paginators.ListFlowsPublisher publisher = client.listFlowsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.appflow.model.ListFlowsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.appflow.model.ListFlowsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest) operation.

      This is a convenience which creates an instance of the ListFlowsRequest.Builder avoiding the need to create one manually via ListFlowsRequest.builder()

      Parameters:
      listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • ValidationException The request has invalid or missing parameters.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Retrieves the tags that are associated with a specified flow.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Retrieves the tags that are associated with a specified flow.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerConnector

      default CompletableFuture<RegisterConnectorResponse> 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.

      Parameters:
      registerConnectorRequest -
      Returns:
      A Java Future containing the result of the RegisterConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerConnector

      default CompletableFuture<RegisterConnectorResponse> registerConnector(Consumer<RegisterConnectorRequest.Builder> 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.


      This is a convenience which creates an instance of the RegisterConnectorRequest.Builder avoiding the need to create one manually via RegisterConnectorRequest.builder()

      Parameters:
      registerConnectorRequest - A Consumer that will call methods on RegisterConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetConnectorMetadataCache

      default CompletableFuture<ResetConnectorMetadataCacheResponse> 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.

      Parameters:
      resetConnectorMetadataCacheRequest -
      Returns:
      A Java Future containing the result of the ResetConnectorMetadataCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetConnectorMetadataCache

      default CompletableFuture<ResetConnectorMetadataCacheResponse> resetConnectorMetadataCache(Consumer<ResetConnectorMetadataCacheRequest.Builder> 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.


      This is a convenience which creates an instance of the ResetConnectorMetadataCacheRequest.Builder avoiding the need to create one manually via ResetConnectorMetadataCacheRequest.builder()

      Parameters:
      resetConnectorMetadataCacheRequest - A Consumer that will call methods on ResetConnectorMetadataCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetConnectorMetadataCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFlow

      default CompletableFuture<StartFlowResponse> 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:
      A Java Future containing the result of the StartFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startFlow

      default CompletableFuture<StartFlowResponse> startFlow(Consumer<StartFlowRequest.Builder> 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.


      This is a convenience which creates an instance of the StartFlowRequest.Builder avoiding the need to create one manually via StartFlowRequest.builder()

      Parameters:
      startFlowRequest - A Consumer that will call methods on StartFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopFlow

      default CompletableFuture<StopFlowResponse> 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:
      A Java Future containing the result of the StopFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopFlow

      default CompletableFuture<StopFlowResponse> stopFlow(Consumer<StopFlowRequest.Builder> 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.


      This is a convenience which creates an instance of the StopFlowRequest.Builder avoiding the need to create one manually via StopFlowRequest.builder()

      Parameters:
      stopFlowRequest - A Consumer that will call methods on StopFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Applies a tag to the specified flow.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Applies a tag to the specified flow.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unregisterConnector

      default CompletableFuture<UnregisterConnectorResponse> unregisterConnector(UnregisterConnectorRequest unregisterConnectorRequest)

      Unregisters the custom connector registered in your account that matches the connector label provided in the request.

      Parameters:
      unregisterConnectorRequest -
      Returns:
      A Java Future containing the result of the UnregisterConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unregisterConnector

      default CompletableFuture<UnregisterConnectorResponse> unregisterConnector(Consumer<UnregisterConnectorRequest.Builder> unregisterConnectorRequest)

      Unregisters the custom connector registered in your account that matches the connector label provided in the request.


      This is a convenience which creates an instance of the UnregisterConnectorRequest.Builder avoiding the need to create one manually via UnregisterConnectorRequest.builder()

      Parameters:
      unregisterConnectorRequest - A Consumer that will call methods on UnregisterConnectorRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UnregisterConnector operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes a tag from the specified flow.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes a tag from the specified flow.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectorProfile

      default CompletableFuture<UpdateConnectorProfileResponse> updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest)

      Updates a given connector profile associated with your account.

      Parameters:
      updateConnectorProfileRequest -
      Returns:
      A Java Future containing the result of the UpdateConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectorProfile

      default CompletableFuture<UpdateConnectorProfileResponse> updateConnectorProfile(Consumer<UpdateConnectorProfileRequest.Builder> updateConnectorProfileRequest)

      Updates a given connector profile associated with your account.


      This is a convenience which creates an instance of the UpdateConnectorProfileRequest.Builder avoiding the need to create one manually via UpdateConnectorProfileRequest.builder()

      Parameters:
      updateConnectorProfileRequest - A Consumer that will call methods on UpdateConnectorProfileRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnectorProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectorRegistration

      default CompletableFuture<UpdateConnectorRegistrationResponse> 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

      Parameters:
      updateConnectorRegistrationRequest -
      Returns:
      A Java Future containing the result of the UpdateConnectorRegistration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateConnectorRegistration

      default CompletableFuture<UpdateConnectorRegistrationResponse> updateConnectorRegistration(Consumer<UpdateConnectorRegistrationRequest.Builder> 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


      This is a convenience which creates an instance of the UpdateConnectorRegistrationRequest.Builder avoiding the need to create one manually via UpdateConnectorRegistrationRequest.builder()

      Parameters:
      updateConnectorRegistrationRequest - A Consumer that will call methods on UpdateConnectorRegistrationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateConnectorRegistration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlow

      default CompletableFuture<UpdateFlowResponse> updateFlow(UpdateFlowRequest updateFlowRequest)

      Updates an existing flow.

      Parameters:
      updateFlowRequest -
      Returns:
      A Java Future containing the result of the UpdateFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateFlow

      default CompletableFuture<UpdateFlowResponse> updateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest)

      Updates an existing flow.


      This is a convenience which creates an instance of the UpdateFlowRequest.Builder avoiding the need to create one manually via UpdateFlowRequest.builder()

      Parameters:
      updateFlowRequest - A Consumer that will call methods on UpdateFlowRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateFlow operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • AppflowException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default AppflowServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static AppflowAsyncClient create()
      Create a AppflowAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static AppflowAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a AppflowAsyncClient.