@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AppflowClient extends AwsClient
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.
| 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 AppflowClientBuilder |
builder()
Create a builder that can be used to configure and create a
AppflowClient. |
default CancelFlowExecutionsResponse |
cancelFlowExecutions(CancelFlowExecutionsRequest cancelFlowExecutionsRequest)
Cancels active runs for a flow.
|
default CancelFlowExecutionsResponse |
cancelFlowExecutions(Consumer<CancelFlowExecutionsRequest.Builder> cancelFlowExecutionsRequest)
Cancels active runs for a flow.
|
static AppflowClient |
create()
Create a
AppflowClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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.
|
default DescribeConnectorProfilesResponse |
describeConnectorProfiles(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default DescribeConnectorProfilesResponse |
describeConnectorProfiles(DescribeConnectorProfilesRequest describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default DescribeConnectorProfilesIterable |
describeConnectorProfilesPaginator(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
default DescribeConnectorProfilesIterable |
describeConnectorProfilesPaginator(DescribeConnectorProfilesRequest describeConnectorProfilesRequest)
Returns a list of
connector-profile details matching the provided connector-profile
names and connector-types. |
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)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
default DescribeConnectorsIterable |
describeConnectorsPaginator(DescribeConnectorsRequest describeConnectorsRequest)
Describes the connectors vended by Amazon AppFlow for specified connector types.
|
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.
|
default DescribeFlowExecutionRecordsResponse |
describeFlowExecutionRecords(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default DescribeFlowExecutionRecordsResponse |
describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default DescribeFlowExecutionRecordsIterable |
describeFlowExecutionRecordsPaginator(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
default DescribeFlowExecutionRecordsIterable |
describeFlowExecutionRecordsPaginator(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest)
Fetches the execution history of the flow.
|
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)
Returns the list of all registered custom connectors in your Amazon Web Services account.
|
default ListConnectorsIterable |
listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
Returns the list of all registered custom connectors in your Amazon Web Services account.
|
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)
Lists all of the flows associated with your account.
|
default ListFlowsIterable |
listFlowsPaginator(ListFlowsRequest listFlowsRequest)
Lists all of the flows associated with your account.
|
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.
|
default ResetConnectorMetadataCacheResponse |
resetConnectorMetadataCache(Consumer<ResetConnectorMetadataCacheRequest.Builder> resetConnectorMetadataCacheRequest)
Resets metadata about your connector entities that Amazon AppFlow stored in its cache.
|
default ResetConnectorMetadataCacheResponse |
resetConnectorMetadataCache(ResetConnectorMetadataCacheRequest resetConnectorMetadataCacheRequest)
Resets metadata about your connector entities that Amazon AppFlow stored in its cache.
|
default AppflowServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
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.
|
default UpdateConnectorRegistrationResponse |
updateConnectorRegistration(Consumer<UpdateConnectorRegistrationRequest.Builder> updateConnectorRegistrationRequest)
Updates a custom connector that you've previously registered.
|
default UpdateConnectorRegistrationResponse |
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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 becomes Canceled.
When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.
cancelFlowExecutionsRequest - ValidationException - The request has invalid or missing parameters.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 becomes Canceled.
When you cancel a run, you still incur charges for any data that the run already processed before the cancellation. If the run had already written some data to the flow destination, then that data remains in the destination. If you configured the flow to use a batch API (such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire batch of data after the cancellation. For these operations, the data processing charges for Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.
This is a convenience which creates an instance of the CancelFlowExecutionsRequest.Builder avoiding the
need to create one manually via CancelFlowExecutionsRequest.builder()
cancelFlowExecutionsRequest - A Consumer that will call methods on CancelFlowExecutionsRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createConnectorProfileRequest - ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via CreateConnectorProfileRequest.builder()
createConnectorProfileRequest - A Consumer that will call methods on CreateConnectorProfileRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFlowResponse createFlow(CreateFlowRequest createFlowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, 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.
createFlowRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateFlowResponse createFlow(Consumer<CreateFlowRequest.Builder> createFlowRequest) throws ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, 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 via CreateFlowRequest.builder()
createFlowRequest - A Consumer that will call methods on CreateFlowRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteConnectorProfileResponse deleteConnectorProfile(DeleteConnectorProfileRequest deleteConnectorProfileRequest) throws ResourceNotFoundException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Enables you to delete an existing connector profile.
deleteConnectorProfileRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteConnectorProfileRequest.builder()
deleteConnectorProfileRequest - A Consumer that will call methods on DeleteConnectorProfileRequest.Builder to create a
request.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteFlowRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DeleteFlowRequest.builder()
deleteFlowRequest - A Consumer that will call methods on DeleteFlowRequest.Builder to create a request.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeConnectorRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeConnectorRequest.builder()
describeConnectorRequest - A Consumer that will call methods on DescribeConnectorRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeConnectorEntityRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeConnectorEntityRequest.builder()
describeConnectorEntityRequest - A Consumer that will call methods on DescribeConnectorEntityRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorProfilesResponse describeConnectorProfiles(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorProfilesResponse describeConnectorProfiles(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorProfilesIterable describeConnectorProfilesPaginator(DescribeConnectorProfilesRequest describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeConnectorProfilesRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorProfilesIterable describeConnectorProfilesPaginator(Consumer<DescribeConnectorProfilesRequest.Builder> describeConnectorProfilesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeConnectorProfilesIterable responses = client.describeConnectorProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeConnectorProfilesRequest.builder()
describeConnectorProfilesRequest - A Consumer that will call methods on DescribeConnectorProfilesRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 the DescribeConnectors API operation to retrieve the next page.
describeConnectorsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 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.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorsIterable describeConnectorsPaginator(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 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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeConnectorsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeConnectorsIterable describeConnectorsPaginator(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 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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeConnectorsIterable responses = client.describeConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeConnectorsRequest.builder()
describeConnectorsRequest - A Consumer that will call methods on DescribeConnectorsRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFlowResponse describeFlow(DescribeFlowRequest describeFlowRequest) throws ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Provides a description of the specified flow.
describeFlowRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeFlowRequest.builder()
describeFlowRequest - A Consumer that will call methods on DescribeFlowRequest.Builder to create a request.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFlowExecutionRecordsResponse describeFlowExecutionRecords(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Fetches the execution history of the flow.
describeFlowExecutionRecordsRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via DescribeFlowExecutionRecordsRequest.builder()
describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create
a request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFlowExecutionRecordsIterable describeFlowExecutionRecordsPaginator(DescribeFlowExecutionRecordsRequest describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeFlowExecutionRecordsRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeFlowExecutionRecordsIterable describeFlowExecutionRecordsPaginator(Consumer<DescribeFlowExecutionRecordsRequest.Builder> describeFlowExecutionRecordsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.DescribeFlowExecutionRecordsIterable responses = client.describeFlowExecutionRecordsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via DescribeFlowExecutionRecordsRequest.builder()
describeFlowExecutionRecordsRequest - A Consumer that will call methods on DescribeFlowExecutionRecordsRequest.Builder to create
a request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listConnectorEntitiesRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListConnectorEntitiesRequest.builder()
listConnectorEntitiesRequest - A Consumer that will call methods on ListConnectorEntitiesRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listConnectorsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListConnectorsRequest.builder()
listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConnectorsIterable listConnectorsPaginator(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.
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 Stream
software.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listConnectorsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListConnectorsIterable listConnectorsPaginator(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 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 Stream
software.amazon.awssdk.services.appflow.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListConnectorsRequest.builder()
listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowsResponse listFlows(ListFlowsRequest listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Lists all of the flows associated with your account.
listFlowsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListFlowsRequest.builder()
listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowsIterable listFlowsPaginator(ListFlowsRequest listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listFlowsRequest - ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListFlowsIterable listFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
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 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 Stream
software.amazon.awssdk.services.appflow.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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 via ListFlowsRequest.builder()
listFlowsRequest - A Consumer that will call methods on ListFlowsRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException
Retrieves the tags that are associated with a specified flow.
listTagsForResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
registerConnectorRequest - ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via RegisterConnectorRequest.builder()
registerConnectorRequest - A Consumer that will call methods on RegisterConnectorRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
resetConnectorMetadataCacheRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via ResetConnectorMetadataCacheRequest.builder()
resetConnectorMetadataCacheRequest - A Consumer that will call methods on ResetConnectorMetadataCacheRequest.Builder to create
a request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
startFlowRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via StartFlowRequest.builder()
startFlowRequest - A Consumer that will call methods on StartFlowRequest.Builder to create a request.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
stopFlowRequest - ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.UnsupportedOperationException - The requested operation is not supported for the current flow.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault 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 via StopFlowRequest.builder()
stopFlowRequest - A Consumer that will call methods on StopFlowRequest.Builder to create a request.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.UnsupportedOperationException - The requested operation is not supported for the current flow.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.UnsupportedOperationExceptionAwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException
Applies a tag to the specified flow.
tagResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
unregisterConnectorRequest - ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UnregisterConnectorRequest.builder()
unregisterConnectorRequest - A Consumer that will call methods on UnregisterConnectorRequest.Builder to create a
request.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, AppflowException
Removes a tag from the specified flow.
untagResourceRequest - InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateConnectorProfileResponse updateConnectorProfile(UpdateConnectorProfileRequest updateConnectorProfileRequest) throws ValidationException, ResourceNotFoundException, ConflictException, ConnectorAuthenticationException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Updates a given connector profile associated with your account.
updateConnectorProfileRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateConnectorProfileRequest.builder()
updateConnectorProfileRequest - A Consumer that will call methods on UpdateConnectorProfileRequest.Builder to create a
request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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
updateConnectorRegistrationRequest - ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 via UpdateConnectorRegistrationRequest.builder()
updateConnectorRegistrationRequest - A Consumer that will call methods on UpdateConnectorRegistrationRequest.Builder to create
a request.ValidationException - The request has invalid or missing parameters.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.AccessDeniedException - AppFlow/Requester has invalid or missing permissions.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ThrottlingException - API calls have exceeded the maximum allowed API request rate per account and per Region.InternalServerException - An internal service error occurred during the processing of your request. Try again later.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFlowResponse updateFlow(UpdateFlowRequest updateFlowRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, AwsServiceException, SdkClientException, AppflowException
Updates an existing flow.
updateFlowRequest - ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateFlowResponse updateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest) throws ValidationException, ResourceNotFoundException, ServiceQuotaExceededException, ConflictException, ConnectorAuthenticationException, ConnectorServerException, InternalServerException, 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 via UpdateFlowRequest.builder()
updateFlowRequest - A Consumer that will call methods on UpdateFlowRequest.Builder to create a request.ValidationException - The request has invalid or missing parameters.ResourceNotFoundException - The resource specified in the request (such as the source or destination connector profile) is not found.ServiceQuotaExceededException - The request would cause a service quota (such as the number of flows) to be exceeded.ConflictException - There was a conflict when processing the request (for example, a flow with the given name already exists
within the account. Check for conflicting resource names and try again.ConnectorAuthenticationException - An error occurred when authenticating with the connector endpoint.ConnectorServerException - An error occurred when retrieving data from the connector endpoint.InternalServerException - An internal service error occurred during the processing of your request. Try again later.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.AppflowException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic AppflowClient create()
AppflowClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AppflowClientBuilder builder()
AppflowClient.static ServiceMetadata serviceMetadata()
default AppflowServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.