@Generated(value="software.amazon.awssdk:codegen") public interface AppflowAsyncClient extends SdkClient
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 AWS services like Amazon S3 and Amazon Redshift.
Use the following links to get started on the Amazon AppFlow API:
Actions: An alphabetical list of all Amazon AppFlow API operations.
Data types: An alphabetical list of all Amazon AppFlow data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.
Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such
as auth-code and redirecturi) with the connector-specific
ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations.
For example, Salesforce users can refer to the Authorize Apps with OAuth
documentation.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static AppflowAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
AppflowAsyncClient. |
static AppflowAsyncClient |
create()
Create a
AppflowAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateConnectorProfileResponse> |
createConnectorProfile(Consumer<CreateConnectorProfileRequest.Builder> createConnectorProfileRequest)
Creates a new connector profile associated with your AWS account.
|
default CompletableFuture<CreateConnectorProfileResponse> |
createConnectorProfile(CreateConnectorProfileRequest createConnectorProfileRequest)
Creates a new connector profile associated with your AWS account.
|
default CompletableFuture<CreateFlowResponse> |
createFlow(Consumer<CreateFlowRequest.Builder> createFlowRequest)
Enables your application to create a new flow using Amazon AppFlow.
|
default CompletableFuture<CreateFlowResponse> |
createFlow(CreateFlowRequest createFlowRequest)
Enables your application to create a new flow using Amazon AppFlow.
|
default CompletableFuture<DeleteConnectorProfileResponse> |
deleteConnectorProfile(Consumer<DeleteConnectorProfileRequest.Builder> deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
|
default CompletableFuture<DeleteConnectorProfileResponse> |
deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
|
default CompletableFuture<DeleteFlowResponse> |
deleteFlow(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest)
Enables your application to delete an existing flow.
|
default CompletableFuture<DeleteFlowResponse> |
deleteFlow(DeleteFlowRequest deleteFlowRequest)
Enables your application to delete an existing flow.
|
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
entity.
|
default CompletableFuture<DescribeConnectorEntityResponse> |
describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest)
Provides details regarding the entity used with the connector, with a description of the data model for each
entity.
|
default CompletableFuture<DescribeConnectorProfilesResponse> |
describeConnectorProfiles(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default CompletableFuture<DescribeConnectorProfilesResponse> |
describeConnectorProfiles(DescribeConnectorProfilesRequest describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default DescribeConnectorProfilesPublisher |
describeConnectorProfilesPaginator(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default DescribeConnectorProfilesPublisher |
describeConnectorProfilesPaginator(DescribeConnectorProfilesRequest describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default CompletableFuture<DescribeConnectorsResponse> |
describeConnectors(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
default CompletableFuture<DescribeConnectorsResponse> |
describeConnectors(DescribeConnectorsRequest describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
default DescribeConnectorsPublisher |
describeConnectorsPaginator(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
default DescribeConnectorsPublisher |
describeConnectorsPaginator(DescribeConnectorsRequest describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
default CompletableFuture<DescribeFlowResponse> |
describeFlow(Consumer<DescribeFlowRequest.Builder> describeFlowRequest)
Provides a description of the specified flow.
|
default CompletableFuture<DescribeFlowResponse> |
describeFlow(DescribeFlowRequest describeFlowRequest)
Provides a description of the specified flow.
|
default CompletableFuture<DescribeFlowExecutionRecordsResponse> |
describeFlowExecutionRecords(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default CompletableFuture<DescribeFlowExecutionRecordsResponse> |
describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default DescribeFlowExecutionRecordsPublisher |
describeFlowExecutionRecordsPaginator(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default DescribeFlowExecutionRecordsPublisher |
describeFlowExecutionRecordsPaginator(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default CompletableFuture<ListConnectorEntitiesResponse> |
listConnectorEntities(Consumer<ListConnectorEntitiesRequest.Builder> listConnectorEntitiesRequest)
Returns the list of available connector entities supported by Amazon AppFlow.
|
default CompletableFuture<ListConnectorEntitiesResponse> |
listConnectorEntities(ListConnectorEntitiesRequest listConnectorEntitiesRequest)
Returns the list of available connector entities supported by Amazon AppFlow.
|
default CompletableFuture<ListFlowsResponse> |
listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest)
Lists all of the flows associated with your account.
|
default CompletableFuture<ListFlowsResponse> |
listFlows(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
|
default ListFlowsPublisher |
listFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest)
Lists all of the flows associated with your account.
|
default ListFlowsPublisher |
listFlowsPaginator(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
|
default CompletableFuture<StartFlowResponse> |
startFlow(Consumer<StartFlowRequest.Builder> startFlowRequest)
Activates an existing flow.
|
default CompletableFuture<StartFlowResponse> |
startFlow(StartFlowRequest startFlowRequest)
Activates an existing flow.
|
default CompletableFuture<StopFlowResponse> |
stopFlow(Consumer<StopFlowRequest.Builder> stopFlowRequest)
Deactivates the existing flow.
|
default CompletableFuture<StopFlowResponse> |
stopFlow(StopFlowRequest stopFlowRequest)
Deactivates the existing flow.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies a tag to the specified flow.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to the specified flow.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes a tag from the specified flow.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified flow.
|
default CompletableFuture<UpdateConnectorProfileResponse> |
updateConnectorProfile(Consumer<UpdateConnectorProfileRequest.Builder> updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
|
default CompletableFuture<UpdateConnectorProfileResponse> |
updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
|
default CompletableFuture<UpdateFlowResponse> |
updateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest)
Updates an existing flow.
|
default CompletableFuture<UpdateFlowResponse> |
updateFlow(UpdateFlowRequest updateFlowRequest)
Updates an existing flow.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static AppflowAsyncClient create()
AppflowAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AppflowAsyncClientBuilder builder()
AppflowAsyncClient.default CompletableFuture<CreateConnectorProfileResponse> createConnectorProfile(CreateConnectorProfileRequest createConnectorProfileRequest)
Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.
createConnectorProfileRequest - default CompletableFuture<CreateConnectorProfileResponse> createConnectorProfile(Consumer<CreateConnectorProfileRequest.Builder> createConnectorProfileRequest)
Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.
This is a convenience which creates an instance of the CreateConnectorProfileRequest.Builder avoiding the
need to create one manually via CreateConnectorProfileRequest.builder()
createConnectorProfileRequest - A Consumer that will call methods on CreateConnectorProfileRequest.Builder to create a
request.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.
createFlowRequest - 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()
createFlowRequest - A Consumer that will call methods on CreateFlowRequest.Builder to create a request.default CompletableFuture<DeleteConnectorProfileResponse> deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest)
Enables you to delete an existing connector profile.
deleteConnectorProfileRequest - 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()
deleteConnectorProfileRequest - A Consumer that will call methods on DeleteConnectorProfileRequest.Builder to create a
request.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.
deleteFlowRequest - 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()
deleteFlowRequest - A Consumer that will call methods on DeleteFlowRequest.Builder to create a request.default CompletableFuture<DescribeConnectorEntityResponse> describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest)
Provides details regarding the entity used with the connector, with a description of the data model for each entity.
describeConnectorEntityRequest - 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 entity.
This is a convenience which creates an instance of the DescribeConnectorEntityRequest.Builder avoiding
the need to create one manually via DescribeConnectorEntityRequest.builder()
describeConnectorEntityRequest - A Consumer that will call methods on DescribeConnectorEntityRequest.Builder to create a
request.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.
describeConnectorProfilesRequest - 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()
describeConnectorProfilesRequest - A Consumer that will call methods on DescribeConnectorProfilesRequest.Builder to create a
request.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.
describeConnectorProfilesRequest - 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()
describeConnectorProfilesRequest - A Consumer that will call methods on DescribeConnectorProfilesRequest.Builder to create a
request.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.
describeConnectorsRequest - 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()
describeConnectorsRequest - A Consumer that will call methods on DescribeConnectorsRequest.Builder to create a
request.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 null 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.
describeConnectorsRequest - 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 null 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()
describeConnectorsRequest - A Consumer that will call methods on DescribeConnectorsRequest.Builder to create a
request.default CompletableFuture<DescribeFlowResponse> describeFlow(DescribeFlowRequest describeFlowRequest)
Provides a description of the specified flow.
describeFlowRequest - 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()
describeFlowRequest - A Consumer that will call methods on DescribeFlowRequest.Builder to create a request.default CompletableFuture<DescribeFlowExecutionRecordsResponse> describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
describeFlowExecutionRecordsRequest - 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()
describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create
a request.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.
describeFlowExecutionRecordsRequest - 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()
describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create
a request.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.
listConnectorEntitiesRequest - 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()
listConnectorEntitiesRequest - A Consumer that will call methods on ListConnectorEntitiesRequest.Builder to create a
request.default CompletableFuture<ListFlowsResponse> listFlows(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
listFlowsRequest - 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()
listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.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.
listFlowsRequest - 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()
listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Retrieves the tags that are associated with a specified flow.
listTagsForResourceRequest - 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.
startFlowRequest - 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()
startFlowRequest - A Consumer that will call methods on StartFlowRequest.Builder to create a request.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.
stopFlowRequest - 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()
stopFlowRequest - A Consumer that will call methods on StopFlowRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to the specified flow.
tagResourceRequest - 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()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from the specified flow.
untagResourceRequest - 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateConnectorProfileResponse> updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest)
Updates a given connector profile associated with your account.
updateConnectorProfileRequest - 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()
updateConnectorProfileRequest - A Consumer that will call methods on UpdateConnectorProfileRequest.Builder to create a
request.default CompletableFuture<UpdateFlowResponse> updateFlow(UpdateFlowRequest updateFlowRequest)
Updates an existing flow.
updateFlowRequest - 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()
updateFlowRequest - A Consumer that will call methods on UpdateFlowRequest.Builder to create a request.