Interface AppflowClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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 Amazon Web Services like Amazon S3 and Amazon Redshift.
Use the following links to get started on the Amazon AppFlow API:
-
Actions: An alphabetical list of all Amazon AppFlow API operations.
-
Data types: An alphabetical list of all Amazon AppFlow data types.
-
Common parameters: Parameters that all Query operations can use.
-
Common errors: Client and server errors that all operations can return.
If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.
Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such
as auth-code
and redirecturi
) with the connector-specific
ConnectorProfileProperties
when creating a new connector profile using Amazon AppFlow API operations.
For example, Salesforce users can refer to the Authorize Apps with OAuth
documentation.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic AppflowClientBuilder
builder()
Create a builder that can be used to configure and create aAppflowClient
.default CancelFlowExecutionsResponse
cancelFlowExecutions
(Consumer<CancelFlowExecutionsRequest.Builder> cancelFlowExecutionsRequest) Cancels active runs for a flow.default CancelFlowExecutionsResponse
cancelFlowExecutions
(CancelFlowExecutionsRequest cancelFlowExecutionsRequest) Cancels active runs for a flow.static AppflowClient
create()
Create aAppflowClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateConnectorProfileResponse
createConnectorProfile
(Consumer<CreateConnectorProfileRequest.Builder> createConnectorProfileRequest) Creates a new connector profile associated with your Amazon Web Services account.default CreateConnectorProfileResponse
createConnectorProfile
(CreateConnectorProfileRequest createConnectorProfileRequest) Creates a new connector profile associated with your Amazon Web Services account.default CreateFlowResponse
createFlow
(Consumer<CreateFlowRequest.Builder> createFlowRequest) Enables your application to create a new flow using Amazon AppFlow.default CreateFlowResponse
createFlow
(CreateFlowRequest createFlowRequest) Enables your application to create a new flow using Amazon AppFlow.default DeleteConnectorProfileResponse
deleteConnectorProfile
(Consumer<DeleteConnectorProfileRequest.Builder> deleteConnectorProfileRequest) Enables you to delete an existing connector profile.default DeleteConnectorProfileResponse
deleteConnectorProfile
(DeleteConnectorProfileRequest deleteConnectorProfileRequest) Enables you to delete an existing connector profile.default DeleteFlowResponse
deleteFlow
(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest) Enables your application to delete an existing flow.default DeleteFlowResponse
deleteFlow
(DeleteFlowRequest deleteFlowRequest) Enables your application to delete an existing flow.default DescribeConnectorResponse
describeConnector
(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest) Describes the given custom connector registered in your Amazon Web Services account.default DescribeConnectorResponse
describeConnector
(DescribeConnectorRequest describeConnectorRequest) Describes the given custom connector registered in your Amazon Web Services account.default 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.default 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.describeConnectorProfiles
(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) Returns a list ofconnector-profile
details matching the providedconnector-profile
names andconnector-types
.describeConnectorProfiles
(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) Returns a list ofconnector-profile
details matching the providedconnector-profile
names andconnector-types
.describeConnectorProfilesPaginator
(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) This is a variant ofdescribeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest)
operation.describeConnectorProfilesPaginator
(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) This is a variant ofdescribeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest)
operation.default DescribeConnectorsResponse
describeConnectors
(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest) Describes the connectors vended by Amazon AppFlow for specified connector types.default DescribeConnectorsResponse
describeConnectors
(DescribeConnectorsRequest describeConnectorsRequest) Describes the connectors vended by Amazon AppFlow for specified connector types.default DescribeConnectorsIterable
describeConnectorsPaginator
(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest) This is a variant ofdescribeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest)
operation.default DescribeConnectorsIterable
describeConnectorsPaginator
(DescribeConnectorsRequest describeConnectorsRequest) This is a variant ofdescribeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest)
operation.default DescribeFlowResponse
describeFlow
(Consumer<DescribeFlowRequest.Builder> describeFlowRequest) Provides a description of the specified flow.default DescribeFlowResponse
describeFlow
(DescribeFlowRequest describeFlowRequest) Provides a description of the specified flow.describeFlowExecutionRecords
(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest) Fetches the execution history of the flow.describeFlowExecutionRecords
(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) Fetches the execution history of the flow.describeFlowExecutionRecordsPaginator
(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest) This is a variant ofdescribeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest)
operation.describeFlowExecutionRecordsPaginator
(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) This is a variant ofdescribeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest)
operation.default ListConnectorEntitiesResponse
listConnectorEntities
(Consumer<ListConnectorEntitiesRequest.Builder> listConnectorEntitiesRequest) Returns the list of available connector entities supported by Amazon AppFlow.default ListConnectorEntitiesResponse
listConnectorEntities
(ListConnectorEntitiesRequest listConnectorEntitiesRequest) Returns the list of available connector entities supported by Amazon AppFlow.default ListConnectorsResponse
listConnectors
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) Returns the list of all registered custom connectors in your Amazon Web Services account.default ListConnectorsResponse
listConnectors
(ListConnectorsRequest listConnectorsRequest) Returns the list of all registered custom connectors in your Amazon Web Services account.default ListConnectorsIterable
listConnectorsPaginator
(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest)
operation.default ListConnectorsIterable
listConnectorsPaginator
(ListConnectorsRequest listConnectorsRequest) This is a variant oflistConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest)
operation.default ListFlowsResponse
listFlows
(Consumer<ListFlowsRequest.Builder> listFlowsRequest) Lists all of the flows associated with your account.default ListFlowsResponse
listFlows
(ListFlowsRequest listFlowsRequest) Lists all of the flows associated with your account.default ListFlowsIterable
listFlowsPaginator
(Consumer<ListFlowsRequest.Builder> listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest)
operation.default ListFlowsIterable
listFlowsPaginator
(ListFlowsRequest listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Retrieves the tags that are associated with a specified flow.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Retrieves the tags that are associated with a specified flow.default RegisterConnectorResponse
registerConnector
(Consumer<RegisterConnectorRequest.Builder> registerConnectorRequest) Registers a new custom connector with your Amazon Web Services account.default RegisterConnectorResponse
registerConnector
(RegisterConnectorRequest registerConnectorRequest) Registers a new custom connector with your Amazon Web Services account.resetConnectorMetadataCache
(Consumer<ResetConnectorMetadataCacheRequest.Builder> resetConnectorMetadataCacheRequest) Resets metadata about your connector entities that Amazon AppFlow stored in its cache.resetConnectorMetadataCache
(ResetConnectorMetadataCacheRequest resetConnectorMetadataCacheRequest) Resets metadata about your connector entities that Amazon AppFlow stored in its cache.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartFlowResponse
startFlow
(Consumer<StartFlowRequest.Builder> startFlowRequest) Activates an existing flow.default StartFlowResponse
startFlow
(StartFlowRequest startFlowRequest) Activates an existing flow.default StopFlowResponse
stopFlow
(Consumer<StopFlowRequest.Builder> stopFlowRequest) Deactivates the existing flow.default StopFlowResponse
stopFlow
(StopFlowRequest stopFlowRequest) Deactivates the existing flow.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies a tag to the specified flow.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Applies a tag to the specified flow.default UnregisterConnectorResponse
unregisterConnector
(Consumer<UnregisterConnectorRequest.Builder> unregisterConnectorRequest) Unregisters the custom connector registered in your account that matches the connector label provided in the request.default UnregisterConnectorResponse
unregisterConnector
(UnregisterConnectorRequest unregisterConnectorRequest) Unregisters the custom connector registered in your account that matches the connector label provided in the request.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag from the specified flow.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag from the specified flow.default UpdateConnectorProfileResponse
updateConnectorProfile
(Consumer<UpdateConnectorProfileRequest.Builder> updateConnectorProfileRequest) Updates a given connector profile associated with your account.default UpdateConnectorProfileResponse
updateConnectorProfile
(UpdateConnectorProfileRequest updateConnectorProfileRequest) Updates a given connector profile associated with your account.updateConnectorRegistration
(Consumer<UpdateConnectorRegistrationRequest.Builder> updateConnectorRegistrationRequest) Updates a custom connector that you've previously registered.updateConnectorRegistration
(UpdateConnectorRegistrationRequest updateConnectorRegistrationRequest) Updates a custom connector that you've previously registered.default UpdateFlowResponse
updateFlow
(Consumer<UpdateFlowRequest.Builder> updateFlowRequest) Updates an existing flow.default UpdateFlowResponse
updateFlow
(UpdateFlowRequest updateFlowRequest) Updates an existing flow.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelFlowExecutions
default CancelFlowExecutionsResponse cancelFlowExecutions(CancelFlowExecutionsRequest cancelFlowExecutionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 becomesCanceled
.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:
- Result of the CancelFlowExecutions operation returned by the service.
- See Also:
-
cancelFlowExecutions
default CancelFlowExecutionsResponse cancelFlowExecutions(Consumer<CancelFlowExecutionsRequest.Builder> cancelFlowExecutionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 becomesCanceled
.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 viaCancelFlowExecutionsRequest.builder()
- Parameters:
cancelFlowExecutionsRequest
- AConsumer
that will call methods onCancelFlowExecutionsRequest.Builder
to create a request.- Returns:
- Result of the CancelFlowExecutions operation returned by the service.
- See Also:
-
createConnectorProfile
default CreateConnectorProfileResponse createConnectorProfile(CreateConnectorProfileRequest createConnectorProfileRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, ConnectorAuthenticationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the CreateConnectorProfile operation returned by the service.
- See Also:
-
createConnectorProfile
default CreateConnectorProfileResponse createConnectorProfile(Consumer<CreateConnectorProfileRequest.Builder> createConnectorProfileRequest) throws ValidationException, ConflictException, ServiceQuotaExceededException, ConnectorAuthenticationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaCreateConnectorProfileRequest.builder()
- Parameters:
createConnectorProfileRequest
- AConsumer
that will call methods onCreateConnectorProfileRequest.Builder
to create a request.- Returns:
- Result of the CreateConnectorProfile operation returned by the service.
- See Also:
-
createFlow
default CreateFlowResponse createFlow(CreateFlowRequest createFlowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, AccessDeniedException, AwsServiceException, SdkClientException, AppflowException Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.
- Parameters:
createFlowRequest
-- Returns:
- Result of the CreateFlow operation returned by the service.
- See Also:
-
createFlow
default CreateFlowResponse createFlow(Consumer<CreateFlowRequest.Builder> createFlowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, AccessDeniedException, AwsServiceException, SdkClientException, AppflowException 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 viaCreateFlowRequest.builder()
- Parameters:
createFlowRequest
- AConsumer
that will call methods onCreateFlowRequest.Builder
to create a request.- Returns:
- Result of the CreateFlow operation returned by the service.
- See Also:
-
deleteConnectorProfile
default DeleteConnectorProfileResponse deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Enables you to delete an existing connector profile.
- Parameters:
deleteConnectorProfileRequest
-- Returns:
- Result of the DeleteConnectorProfile operation returned by the service.
- See Also:
-
deleteConnectorProfile
default DeleteConnectorProfileResponse deleteConnectorProfile(Consumer<DeleteConnectorProfileRequest.Builder> deleteConnectorProfileRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaDeleteConnectorProfileRequest.builder()
- Parameters:
deleteConnectorProfileRequest
- AConsumer
that will call methods onDeleteConnectorProfileRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnectorProfile operation returned by the service.
- See Also:
-
deleteFlow
default DeleteFlowResponse deleteFlow(DeleteFlowRequest deleteFlowRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.
- Parameters:
deleteFlowRequest
-- Returns:
- Result of the DeleteFlow operation returned by the service.
- See Also:
-
deleteFlow
default DeleteFlowResponse deleteFlow(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaDeleteFlowRequest.builder()
- Parameters:
deleteFlowRequest
- AConsumer
that will call methods onDeleteFlowRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlow operation returned by the service.
- See Also:
-
describeConnector
default DescribeConnectorResponse describeConnector(DescribeConnectorRequest describeConnectorRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the DescribeConnector operation returned by the service.
- See Also:
-
describeConnector
default DescribeConnectorResponse describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException 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 viaDescribeConnectorRequest.builder()
- Parameters:
describeConnectorRequest
- AConsumer
that will call methods onDescribeConnectorRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnector operation returned by the service.
- See Also:
-
describeConnectorEntity
default DescribeConnectorEntityResponse describeConnectorEntity(DescribeConnectorEntityRequest describeConnectorEntityRequest) throws ValidationException, ResourceNotFoundException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the DescribeConnectorEntity operation returned by the service.
- See Also:
-
describeConnectorEntity
default DescribeConnectorEntityResponse describeConnectorEntity(Consumer<DescribeConnectorEntityRequest.Builder> describeConnectorEntityRequest) throws ValidationException, ResourceNotFoundException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaDescribeConnectorEntityRequest.builder()
- Parameters:
describeConnectorEntityRequest
- AConsumer
that will call methods onDescribeConnectorEntityRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectorEntity operation returned by the service.
- See Also:
-
describeConnectorProfiles
default DescribeConnectorProfilesResponse describeConnectorProfiles(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Returns a list of
connector-profile
details matching the providedconnector-profile
names andconnector-types
. Both input lists are optional, and you can use them to filter the result.If no names or
connector-types
are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.- Parameters:
describeConnectorProfilesRequest
-- Returns:
- Result of the DescribeConnectorProfiles operation returned by the service.
- See Also:
-
describeConnectorProfiles
default DescribeConnectorProfilesResponse describeConnectorProfiles(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Returns a list of
connector-profile
details matching the providedconnector-profile
names andconnector-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 viaDescribeConnectorProfilesRequest.builder()
- Parameters:
describeConnectorProfilesRequest
- AConsumer
that will call methods onDescribeConnectorProfilesRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectorProfiles operation returned by the service.
- See Also:
-
describeConnectorProfilesPaginator
default DescribeConnectorProfilesIterable describeConnectorProfilesPaginator(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client .describeConnectorProfilesPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeConnectorProfilesPaginator
default DescribeConnectorProfilesIterable describeConnectorProfilesPaginator(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeConnectorProfiles(software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client .describeConnectorProfilesPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeConnectorProfilesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeConnectorProfilesRequest.builder()
- Parameters:
describeConnectorProfilesRequest
- AConsumer
that will call methods onDescribeConnectorProfilesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeConnectors
default DescribeConnectorsResponse describeConnectors(DescribeConnectorsRequest describeConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 theDescribeConnectors
API operation to retrieve the next page.- Parameters:
describeConnectorsRequest
-- Returns:
- Result of the DescribeConnectors operation returned by the service.
- See Also:
-
describeConnectors
default DescribeConnectorsResponse describeConnectors(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 theDescribeConnectors
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 viaDescribeConnectorsRequest.builder()
- Parameters:
describeConnectorsRequest
- AConsumer
that will call methods onDescribeConnectorsRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectors operation returned by the service.
- See Also:
-
describeConnectorsPaginator
default DescribeConnectorsIterable describeConnectorsPaginator(DescribeConnectorsRequest describeConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client .describeConnectorsPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeConnectorsPaginator
default DescribeConnectorsIterable describeConnectorsPaginator(Consumer<DescribeConnectorsRequest.Builder> describeConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeConnectors(software.amazon.awssdk.services.appflow.model.DescribeConnectorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client .describeConnectorsPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeConnectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeConnectorsRequest.builder()
- Parameters:
describeConnectorsRequest
- AConsumer
that will call methods onDescribeConnectorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeFlow
default DescribeFlowResponse describeFlow(DescribeFlowRequest describeFlowRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Provides a description of the specified flow.
- Parameters:
describeFlowRequest
-- Returns:
- Result of the DescribeFlow operation returned by the service.
- See Also:
-
describeFlow
default DescribeFlowResponse describeFlow(Consumer<DescribeFlowRequest.Builder> describeFlowRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaDescribeFlowRequest.builder()
- Parameters:
describeFlowRequest
- AConsumer
that will call methods onDescribeFlowRequest.Builder
to create a request.- Returns:
- Result of the DescribeFlow operation returned by the service.
- See Also:
-
describeFlowExecutionRecords
default DescribeFlowExecutionRecordsResponse describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Fetches the execution history of the flow.
- Parameters:
describeFlowExecutionRecordsRequest
-- Returns:
- Result of the DescribeFlowExecutionRecords operation returned by the service.
- See Also:
-
describeFlowExecutionRecords
default DescribeFlowExecutionRecordsResponse describeFlowExecutionRecords(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaDescribeFlowExecutionRecordsRequest.builder()
- Parameters:
describeFlowExecutionRecordsRequest
- AConsumer
that will call methods onDescribeFlowExecutionRecordsRequest.Builder
to create a request.- Returns:
- Result of the DescribeFlowExecutionRecords operation returned by the service.
- See Also:
-
describeFlowExecutionRecordsPaginator
default DescribeFlowExecutionRecordsIterable describeFlowExecutionRecordsPaginator(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client .describeFlowExecutionRecordsPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeFlowExecutionRecordsPaginator
default DescribeFlowExecutionRecordsIterable describeFlowExecutionRecordsPaginator(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
describeFlowExecutionRecords(software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client .describeFlowExecutionRecordsPaginator(request); for (software.amazon.awssdk.services.appflow.model.DescribeFlowExecutionRecordsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeFlowExecutionRecordsRequest.builder()
- Parameters:
describeFlowExecutionRecordsRequest
- AConsumer
that will call methods onDescribeFlowExecutionRecordsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listConnectorEntities
default ListConnectorEntitiesResponse listConnectorEntities(ListConnectorEntitiesRequest listConnectorEntitiesRequest) throws ValidationException, ResourceNotFoundException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.
- Parameters:
listConnectorEntitiesRequest
-- Returns:
- Result of the ListConnectorEntities operation returned by the service.
- See Also:
-
listConnectorEntities
default ListConnectorEntitiesResponse listConnectorEntities(Consumer<ListConnectorEntitiesRequest.Builder> listConnectorEntitiesRequest) throws ValidationException, ResourceNotFoundException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaListConnectorEntitiesRequest.builder()
- Parameters:
listConnectorEntitiesRequest
- AConsumer
that will call methods onListConnectorEntitiesRequest.Builder
to create a request.- Returns:
- Result of the ListConnectorEntities operation returned by the service.
- See Also:
-
listConnectors
default ListConnectorsResponse listConnectors(ListConnectorsRequest listConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the ListConnectors operation returned by the service.
- See Also:
-
listConnectors
default ListConnectorsResponse listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- Result of the ListConnectors operation returned by the service.
- See Also:
-
listConnectorsPaginator
default ListConnectorsIterable listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); for (software.amazon.awssdk.services.appflow.model.ListConnectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listConnectorsPaginator
default ListConnectorsIterable listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
listConnectors(software.amazon.awssdk.services.appflow.model.ListConnectorsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); for (software.amazon.awssdk.services.appflow.model.ListConnectorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListConnectorsRequest.builder()
- Parameters:
listConnectorsRequest
- AConsumer
that will call methods onListConnectorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlows
default ListFlowsResponse listFlows(ListFlowsRequest listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Lists all of the flows associated with your account.
- Parameters:
listFlowsRequest
-- Returns:
- Result of the ListFlows operation returned by the service.
- See Also:
-
listFlows
default ListFlowsResponse listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaListFlowsRequest.builder()
- Parameters:
listFlowsRequest
- AConsumer
that will call methods onListFlowsRequest.Builder
to create a request.- Returns:
- Result of the ListFlows operation returned by the service.
- See Also:
-
listFlowsPaginator
default ListFlowsIterable listFlowsPaginator(ListFlowsRequest listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); for (software.amazon.awssdk.services.appflow.model.ListFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listFlowsPaginator
default ListFlowsIterable listFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException This is a variant of
listFlows(software.amazon.awssdk.services.appflow.model.ListFlowsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); for (software.amazon.awssdk.services.appflow.model.ListFlowsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListFlowsRequest.builder()
- Parameters:
listFlowsRequest
- AConsumer
that will call methods onListFlowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException Retrieves the tags that are associated with a specified flow.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
registerConnector
default RegisterConnectorResponse registerConnector(RegisterConnectorRequest registerConnectorRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, InternalServerException, ConnectorServerException, ConnectorAuthenticationException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the RegisterConnector operation returned by the service.
- See Also:
-
registerConnector
default RegisterConnectorResponse registerConnector(Consumer<RegisterConnectorRequest.Builder> registerConnectorRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, InternalServerException, ConnectorServerException, ConnectorAuthenticationException, AwsServiceException, SdkClientException, AppflowException 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 viaRegisterConnectorRequest.builder()
- Parameters:
registerConnectorRequest
- AConsumer
that will call methods onRegisterConnectorRequest.Builder
to create a request.- Returns:
- Result of the RegisterConnector operation returned by the service.
- See Also:
-
resetConnectorMetadataCache
default ResetConnectorMetadataCacheResponse resetConnectorMetadataCache(ResetConnectorMetadataCacheRequest resetConnectorMetadataCacheRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the ResetConnectorMetadataCache operation returned by the service.
- See Also:
-
resetConnectorMetadataCache
default ResetConnectorMetadataCacheResponse resetConnectorMetadataCache(Consumer<ResetConnectorMetadataCacheRequest.Builder> resetConnectorMetadataCacheRequest) throws ValidationException, ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaResetConnectorMetadataCacheRequest.builder()
- Parameters:
resetConnectorMetadataCacheRequest
- AConsumer
that will call methods onResetConnectorMetadataCacheRequest.Builder
to create a request.- Returns:
- Result of the ResetConnectorMetadataCache operation returned by the service.
- See Also:
-
startFlow
default StartFlowResponse startFlow(StartFlowRequest startFlowRequest) throws ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, AppflowException Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
- Parameters:
startFlowRequest
-- Returns:
- Result of the StartFlow operation returned by the service.
- See Also:
-
startFlow
default StartFlowResponse startFlow(Consumer<StartFlowRequest.Builder> startFlowRequest) throws ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ConflictException, AwsServiceException, SdkClientException, AppflowException 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 viaStartFlowRequest.builder()
- Parameters:
startFlowRequest
- AConsumer
that will call methods onStartFlowRequest.Builder
to create a request.- Returns:
- Result of the StartFlow operation returned by the service.
- See Also:
-
stopFlow
default StopFlowResponse stopFlow(StopFlowRequest stopFlowRequest) throws ConflictException, ResourceNotFoundException, UnsupportedOperationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Deactivates the existing flow. For on-demand flows, this operation returns an
unsupportedOperationException
error message. For schedule and event-triggered flows, this operation deactivates the flow.- Parameters:
stopFlowRequest
-- Returns:
- Result of the StopFlow operation returned by the service.
- See Also:
-
stopFlow
default StopFlowResponse stopFlow(Consumer<StopFlowRequest.Builder> stopFlowRequest) throws ConflictException, ResourceNotFoundException, UnsupportedOperationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaStopFlowRequest.builder()
- Parameters:
stopFlowRequest
- AConsumer
that will call methods onStopFlowRequest.Builder
to create a request.- Returns:
- Result of the StopFlow operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException Applies a tag to the specified flow.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
unregisterConnector
default UnregisterConnectorResponse unregisterConnector(UnregisterConnectorRequest unregisterConnectorRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Unregisters the custom connector registered in your account that matches the connector label provided in the request.
- Parameters:
unregisterConnectorRequest
-- Returns:
- Result of the UnregisterConnector operation returned by the service.
- See Also:
-
unregisterConnector
default UnregisterConnectorResponse unregisterConnector(Consumer<UnregisterConnectorRequest.Builder> unregisterConnectorRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaUnregisterConnectorRequest.builder()
- Parameters:
unregisterConnectorRequest
- AConsumer
that will call methods onUnregisterConnectorRequest.Builder
to create a request.- Returns:
- Result of the UnregisterConnector operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException Removes a tag from the specified flow.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateConnectorProfile
default UpdateConnectorProfileResponse updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, ConnectorAuthenticationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException Updates a given connector profile associated with your account.
- Parameters:
updateConnectorProfileRequest
-- Returns:
- Result of the UpdateConnectorProfile operation returned by the service.
- See Also:
-
updateConnectorProfile
default UpdateConnectorProfileResponse updateConnectorProfile(Consumer<UpdateConnectorProfileRequest.Builder> updateConnectorProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, ConnectorAuthenticationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException 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 viaUpdateConnectorProfileRequest.builder()
- Parameters:
updateConnectorProfileRequest
- AConsumer
that will call methods onUpdateConnectorProfileRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnectorProfile operation returned by the service.
- See Also:
-
updateConnectorRegistration
default UpdateConnectorRegistrationResponse updateConnectorRegistration(UpdateConnectorRegistrationRequest updateConnectorRegistrationRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, InternalServerException, ConnectorServerException, ConnectorAuthenticationException, AwsServiceException, SdkClientException, AppflowException 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:
- Result of the UpdateConnectorRegistration operation returned by the service.
- See Also:
-
-
updateConnectorRegistration
default UpdateConnectorRegistrationResponse updateConnectorRegistration(Consumer<UpdateConnectorRegistrationRequest.Builder> updateConnectorRegistrationRequest) throws ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, InternalServerException, ConnectorServerException, ConnectorAuthenticationException, AwsServiceException, SdkClientException, AppflowException 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 viaUpdateConnectorRegistrationRequest.builder()
- Parameters:
updateConnectorRegistrationRequest
- AConsumer
that will call methods onUpdateConnectorRegistrationRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnectorRegistration operation returned by the service.
- See Also:
-
-
updateFlow
default UpdateFlowResponse updateFlow(UpdateFlowRequest updateFlowRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, AppflowException Updates an existing flow.
- Parameters:
updateFlowRequest
-- Returns:
- Result of the UpdateFlow operation returned by the service.
- See Also:
-
updateFlow
default UpdateFlowResponse updateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AccessDeniedException, AwsServiceException, SdkClientException, AppflowException Updates an existing flow.
This is a convenience which creates an instance of the
UpdateFlowRequest.Builder
avoiding the need to create one manually viaUpdateFlowRequest.builder()
- Parameters:
updateFlowRequest
- AConsumer
that will call methods onUpdateFlowRequest.Builder
to create a request.- Returns:
- Result of the UpdateFlow operation returned by the service.
- See Also:
-
create
Create aAppflowClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAppflowClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-