Awso_appflow_syncSourceval cancel_flow_executions :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.CancelFlowExecutionsRequest.t ->
(Awso_appflow.Values.CancelFlowExecutionsResponse.t,
Awso_appflow.Values.CancelFlowExecutionsResponse.error)
Result.tval create_connector_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.CreateConnectorProfileRequest.t ->
(Awso_appflow.Values.CreateConnectorProfileResponse.t,
Awso_appflow.Values.CreateConnectorProfileResponse.error)
Result.tval create_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.CreateFlowRequest.t ->
(Awso_appflow.Values.CreateFlowResponse.t,
Awso_appflow.Values.CreateFlowResponse.error)
Result.tval delete_connector_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DeleteConnectorProfileRequest.t ->
(Awso_appflow.Values.DeleteConnectorProfileResponse.t,
Awso_appflow.Values.DeleteConnectorProfileResponse.error)
Result.tval delete_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DeleteFlowRequest.t ->
(Awso_appflow.Values.DeleteFlowResponse.t,
Awso_appflow.Values.DeleteFlowResponse.error)
Result.tval describe_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeConnectorRequest.t ->
(Awso_appflow.Values.DescribeConnectorResponse.t,
Awso_appflow.Values.DescribeConnectorResponse.error)
Result.tval describe_connector_entity :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeConnectorEntityRequest.t ->
(Awso_appflow.Values.DescribeConnectorEntityResponse.t,
Awso_appflow.Values.DescribeConnectorEntityResponse.error)
Result.tval describe_connector_profiles :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeConnectorProfilesRequest.t ->
(Awso_appflow.Values.DescribeConnectorProfilesResponse.t,
Awso_appflow.Values.DescribeConnectorProfilesResponse.error)
Result.tval describe_connectors :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeConnectorsRequest.t ->
(Awso_appflow.Values.DescribeConnectorsResponse.t,
Awso_appflow.Values.DescribeConnectorsResponse.error)
Result.tval describe_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeFlowRequest.t ->
(Awso_appflow.Values.DescribeFlowResponse.t,
Awso_appflow.Values.DescribeFlowResponse.error)
Result.tval describe_flow_execution_records :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.DescribeFlowExecutionRecordsRequest.t ->
(Awso_appflow.Values.DescribeFlowExecutionRecordsResponse.t,
Awso_appflow.Values.DescribeFlowExecutionRecordsResponse.error)
Result.tval list_connector_entities :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.ListConnectorEntitiesRequest.t ->
(Awso_appflow.Values.ListConnectorEntitiesResponse.t,
Awso_appflow.Values.ListConnectorEntitiesResponse.error)
Result.tval list_connectors :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.ListConnectorsRequest.t ->
(Awso_appflow.Values.ListConnectorsResponse.t,
Awso_appflow.Values.ListConnectorsResponse.error)
Result.tval list_flows :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.ListFlowsRequest.t ->
(Awso_appflow.Values.ListFlowsResponse.t,
Awso_appflow.Values.ListFlowsResponse.error)
Result.tval list_tags_for_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.ListTagsForResourceRequest.t ->
(Awso_appflow.Values.ListTagsForResourceResponse.t,
Awso_appflow.Values.ListTagsForResourceResponse.error)
Result.tval register_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.RegisterConnectorRequest.t ->
(Awso_appflow.Values.RegisterConnectorResponse.t,
Awso_appflow.Values.RegisterConnectorResponse.error)
Result.tval reset_connector_metadata_cache :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.ResetConnectorMetadataCacheRequest.t ->
(Awso_appflow.Values.ResetConnectorMetadataCacheResponse.t,
Awso_appflow.Values.ResetConnectorMetadataCacheResponse.error)
Result.tval start_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.StartFlowRequest.t ->
(Awso_appflow.Values.StartFlowResponse.t,
Awso_appflow.Values.StartFlowResponse.error)
Result.tval stop_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.StopFlowRequest.t ->
(Awso_appflow.Values.StopFlowResponse.t,
Awso_appflow.Values.StopFlowResponse.error)
Result.tval tag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.TagResourceRequest.t ->
(Awso_appflow.Values.TagResourceResponse.t,
Awso_appflow.Values.TagResourceResponse.error)
Result.tval unregister_connector :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.UnregisterConnectorRequest.t ->
(Awso_appflow.Values.UnregisterConnectorResponse.t,
Awso_appflow.Values.UnregisterConnectorResponse.error)
Result.tval untag_resource :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.UntagResourceRequest.t ->
(Awso_appflow.Values.UntagResourceResponse.t,
Awso_appflow.Values.UntagResourceResponse.error)
Result.tval update_connector_profile :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.UpdateConnectorProfileRequest.t ->
(Awso_appflow.Values.UpdateConnectorProfileResponse.t,
Awso_appflow.Values.UpdateConnectorProfileResponse.error)
Result.tval update_connector_registration :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.UpdateConnectorRegistrationRequest.t ->
(Awso_appflow.Values.UpdateConnectorRegistrationResponse.t,
Awso_appflow.Values.UpdateConnectorRegistrationResponse.error)
Result.tval update_flow :
?endpoint_url:string ->
?cfg:Awso.Cfg.t ->
Awso_appflow.Values.UpdateFlowRequest.t ->
(Awso_appflow.Values.UpdateFlowResponse.t,
Awso_appflow.Values.UpdateFlowResponse.error)
Result.tinclude module type of struct include Awso_appflow.Values endval structure_to_value_aux :
('a * 'b option) list ->
f:(('a * 'b) list -> 'c) ->
[> `Structure of 'c ]val structure_to_wrapped_value :
wrapper:'a ->
response:'a ->
('b * 'c option) list ->
[> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]Information about required authentication parameters.
The aggregation settings that you can use to customize the output format of your flow data.
Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.
Custom parameter required for OAuth 2.0 authentication.
The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
Determines how Amazon AppFlow handles the success response that it gets from the connector after placing data. For example, this setting would determine where to write the response from the destination connector upon a successful insert operation.
The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
Describes the status of an attempt from Amazon AppFlow to register a resource. When you run a flow that you've configured to use a metadata catalog, Amazon AppFlow registers a metadata table and data partitions with that catalog. This operation provides the status of that registration attempt. The operation also indicates how many related resources Amazon AppFlow created or updated.
Configuration information required for custom authentication.
module ConnectorSuppliedValueOptionList =
Awso_appflow.Values.ConnectorSuppliedValueOptionListThe OAuth 2.0 properties required for OAuth 2.0 authentication.
The OAuth properties required for OAuth type authentication.
The range of values that the property supports.
module CustomConnectorDestinationProperties =
Awso_appflow.Values.CustomConnectorDestinationPropertiesThe properties that are applied when the custom connector is being used as a destination.
module CustomerProfilesDestinationProperties =
Awso_appflow.Values.CustomerProfilesDestinationPropertiesThe properties that are applied when Amazon Connect Customer Profiles is used as a destination.
module EventBridgeDestinationProperties =
Awso_appflow.Values.EventBridgeDestinationPropertiesThe properties that are applied when Amazon EventBridge is being used as a destination.
The properties that are applied when Amazon Honeycode is used as a destination.
module LookoutMetricsDestinationProperties =
Awso_appflow.Values.LookoutMetricsDestinationPropertiesThe properties that are applied when Amazon Lookout for Metrics is used as a destination.
The properties that Amazon AppFlow applies when you use Marketo as a flow destination.
The properties that are applied when Amazon Redshift is being used as a destination.
The properties that are applied when Amazon S3 is used as a destination.
The properties that are applied when using SAPOData as a flow destination
The properties that are applied when Salesforce is being used as a destination.
The properties that are applied when Snowflake is being used as a destination.
The properties that are applied when Upsolver is used as a destination.
The properties that are applied when Zendesk is used as a destination.
The API of the connector application that Amazon AppFlow uses to transfer your data.
When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
Sets the page size for each concurrent process that transfers OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster.
Sets the number of concurrent processes that transfer OData records from your SAP instance. A concurrent process is query that retrieves a batch of records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to transfer data faster.
module GoogleAnalyticsConnectorOperator =
Awso_appflow.Values.GoogleAnalyticsConnectorOperatorThe API key credentials required for API key authentication.
The basic auth credentials required for basic authentication.
The custom credentials required for custom authentication.
The OAuth 2.0 credentials required for OAuth 2.0 authentication.
The OAuth credentials required for OAuth type authentication.
Provides details in the event of a failed flow, including the failure count and the related error messages.
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.
Contains the default values required for OAuth 2.0 authentication.
The connector metadata specific to Amplitude.
The connector metadata specific to Amazon Connect Customer Profiles.
The connector metadata specific to Datadog.
The connector metadata specific to Dynatrace.
The connector metadata specific to Amazon EventBridge.
The connector metadata specific to Google Analytics.
The connector metadata specific to Amazon Honeycode.
The connector metadata specific to Infor Nexus.
The connector metadata specific to Marketo.
The connector metadata specific to Salesforce Pardot.
The connector metadata specific to Amazon Redshift.
The connector metadata specific to Amazon S3.
The connector metadata specific to SAPOData.
The connector metadata specific to Salesforce.
The connector metadata specific to ServiceNow.
The connector metadata specific to Singular.
The connector metadata specific to Slack.
The connector metadata specific to Snowflake.
The connector metadata specific to Trend Micro.
The connector metadata specific to Upsolver.
The connector metadata specific to Veeva.
The connector metadata specific to Zendesk.
module LambdaConnectorProvisioningConfig =
Awso_appflow.Values.LambdaConnectorProvisioningConfigContains information about the configuration of the lambda which is being registered as the connector.
Contains information about the connector runtime settings that are required for flow execution.
module AmplitudeConnectorProfileProperties =
Awso_appflow.Values.AmplitudeConnectorProfilePropertiesThe connector-specific profile properties required when using Amplitude.
module CustomConnectorProfileProperties =
Awso_appflow.Values.CustomConnectorProfilePropertiesThe profile properties required by the custom connector.
module DatadogConnectorProfileProperties =
Awso_appflow.Values.DatadogConnectorProfilePropertiesThe connector-specific profile properties required by Datadog.
module DynatraceConnectorProfileProperties =
Awso_appflow.Values.DynatraceConnectorProfilePropertiesThe connector-specific profile properties required by Dynatrace.
module GoogleAnalyticsConnectorProfileProperties =
Awso_appflow.Values.GoogleAnalyticsConnectorProfilePropertiesThe connector-specific profile properties required by Google Analytics.
module HoneycodeConnectorProfileProperties =
Awso_appflow.Values.HoneycodeConnectorProfilePropertiesThe connector-specific properties required when using Amazon Honeycode.
module InforNexusConnectorProfileProperties =
Awso_appflow.Values.InforNexusConnectorProfilePropertiesThe connector-specific profile properties required by Infor Nexus.
module MarketoConnectorProfileProperties =
Awso_appflow.Values.MarketoConnectorProfilePropertiesThe connector-specific profile properties required when using Marketo.
module PardotConnectorProfileProperties =
Awso_appflow.Values.PardotConnectorProfilePropertiesThe connector-specific profile properties required when using Salesforce Pardot.
module RedshiftConnectorProfileProperties =
Awso_appflow.Values.RedshiftConnectorProfilePropertiesThe connector-specific profile properties when using Amazon Redshift.
module SAPODataConnectorProfileProperties =
Awso_appflow.Values.SAPODataConnectorProfilePropertiesThe connector-specific profile properties required when using SAPOData.
module SalesforceConnectorProfileProperties =
Awso_appflow.Values.SalesforceConnectorProfilePropertiesThe connector-specific profile properties required when using Salesforce.
module ServiceNowConnectorProfileProperties =
Awso_appflow.Values.ServiceNowConnectorProfilePropertiesThe connector-specific profile properties required when using ServiceNow.
module SingularConnectorProfileProperties =
Awso_appflow.Values.SingularConnectorProfilePropertiesThe connector-specific profile properties required when using Singular.
The connector-specific profile properties required when using Slack.
module SnowflakeConnectorProfileProperties =
Awso_appflow.Values.SnowflakeConnectorProfilePropertiesThe connector-specific profile properties required when using Snowflake.
module TrendmicroConnectorProfileProperties =
Awso_appflow.Values.TrendmicroConnectorProfilePropertiesThe connector-specific profile properties required when using Trend Micro.
The connector-specific profile properties required when using Veeva.
module ZendeskConnectorProfileProperties =
Awso_appflow.Values.ZendeskConnectorProfilePropertiesThe connector-specific profile properties required when using Zendesk.
module PrivateConnectionProvisioningFailureCause =
Awso_appflow.Values.PrivateConnectionProvisioningFailureCausemodule PrivateConnectionProvisioningFailureMessage =
Awso_appflow.Values.PrivateConnectionProvisioningFailureMessagemodule PrivateConnectionProvisioningStatus =
Awso_appflow.Values.PrivateConnectionProvisioningStatusContains details regarding the supported field type and the operators that can be applied for filtering.
This stores the information that is required to query a particular connector.
The properties that are applied when Amplitude is being used as a source.
The properties that are applied when the custom connector is being used as a source.
The properties that are applied when Datadog is being used as a source.
The properties that are applied when Dynatrace is being used as a source.
The properties that are applied when Google Analytics is being used as a source.
The properties that are applied when Infor Nexus is being used as a source.
The properties that are applied when Marketo is being used as a source.
The properties that are applied when Salesforce Pardot is being used as a source.
The properties that are applied when Amazon S3 is being used as the flow source.
The properties that are applied when using SAPOData as a flow source.
The properties that are applied when Salesforce is being used as a source.
The properties that are applied when ServiceNow is being used as a source.
The properties that are applied when Singular is being used as a source.
The properties that are applied when Slack is being used as a source.
The properties that are applied when using Trend Micro as a flow source.
The properties that are applied when using Veeva as a flow source.
The properties that are applied when using Zendesk as a flow source.
The operation to be performed on the provided source fields.
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
module AmplitudeConnectorProfileCredentials =
Awso_appflow.Values.AmplitudeConnectorProfileCredentialsThe connector-specific credentials required when using Amplitude.
module CustomConnectorProfileCredentials =
Awso_appflow.Values.CustomConnectorProfileCredentialsThe connector-specific profile credentials that are required when using the custom connector.
module DatadogConnectorProfileCredentials =
Awso_appflow.Values.DatadogConnectorProfileCredentialsThe connector-specific credentials required by Datadog.
module DynatraceConnectorProfileCredentials =
Awso_appflow.Values.DynatraceConnectorProfileCredentialsThe connector-specific profile credentials required by Dynatrace.
module GoogleAnalyticsConnectorProfileCredentials =
Awso_appflow.Values.GoogleAnalyticsConnectorProfileCredentialsThe connector-specific profile credentials required by Google Analytics.
module HoneycodeConnectorProfileCredentials =
Awso_appflow.Values.HoneycodeConnectorProfileCredentialsThe connector-specific credentials required when using Amazon Honeycode.
module InforNexusConnectorProfileCredentials =
Awso_appflow.Values.InforNexusConnectorProfileCredentialsThe connector-specific profile credentials required by Infor Nexus.
module MarketoConnectorProfileCredentials =
Awso_appflow.Values.MarketoConnectorProfileCredentialsThe connector-specific profile credentials required by Marketo.
module PardotConnectorProfileCredentials =
Awso_appflow.Values.PardotConnectorProfileCredentialsThe connector-specific profile credentials required when using Salesforce Pardot.
module RedshiftConnectorProfileCredentials =
Awso_appflow.Values.RedshiftConnectorProfileCredentialsThe connector-specific profile credentials required when using Amazon Redshift.
module SAPODataConnectorProfileCredentials =
Awso_appflow.Values.SAPODataConnectorProfileCredentialsThe connector-specific profile credentials required when using SAPOData.
module SalesforceConnectorProfileCredentials =
Awso_appflow.Values.SalesforceConnectorProfileCredentialsThe connector-specific profile credentials required when using Salesforce.
module ServiceNowConnectorProfileCredentials =
Awso_appflow.Values.ServiceNowConnectorProfileCredentialsThe connector-specific profile credentials required when using ServiceNow.
module SingularConnectorProfileCredentials =
Awso_appflow.Values.SingularConnectorProfileCredentialsThe connector-specific profile credentials required when using Singular.
module SlackConnectorProfileCredentials =
Awso_appflow.Values.SlackConnectorProfileCredentialsThe connector-specific profile credentials required when using Slack.
module SnowflakeConnectorProfileCredentials =
Awso_appflow.Values.SnowflakeConnectorProfileCredentialsThe connector-specific profile credentials required when using Snowflake.
module TrendmicroConnectorProfileCredentials =
Awso_appflow.Values.TrendmicroConnectorProfileCredentialsThe connector-specific profile credentials required when using Trend Micro.
module VeevaConnectorProfileCredentials =
Awso_appflow.Values.VeevaConnectorProfileCredentialsThe connector-specific profile credentials required when using Veeva.
module ZendeskConnectorProfileCredentials =
Awso_appflow.Values.ZendeskConnectorProfileCredentialsThe connector-specific profile credentials required when using Zendesk.
Describes the details of the flow run, including the timestamp, status, and message.
The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.
Specifies the end result of the flow run.
Contains information about the authentication config that the connector supports.
A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Contains information about the configuration of the connector being registered.
The connector-specific profile properties required by each connector.
module PrivateConnectionProvisioningState =
Awso_appflow.Values.PrivateConnectionProvisioningStateSpecifies the private connection provisioning state.
The properties that can be applied to a field when connector is being used as a destination.
The properties that can be applied to a field when the connector is being used as a source.
Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.
Contains information about the configuration of destination connectors present in the flow.
Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data that's transferred by the flow that you configure with these settings. You can configure a flow with these settings only when the flow destination is Amazon S3.
Specifies the configuration used when importing incremental records from the source.
Specifies the information that is required to query a particular connector.
A class for modeling different type of tasks. Task implementation varies based on the TaskType.
Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
The connector-specific credentials required by a connector.
The properties of the flow, such as its source, destination, trigger type, and so on.
Information about the registered connector.
Specifies information about the past flow run instances for a given flow.
The configuration settings related to a given connector.
Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
AppFlow/Requester has invalid or missing permissions.
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.
module ConnectorAuthenticationException =
Awso_appflow.Values.ConnectorAuthenticationExceptionAn error occurred when authenticating with the connector endpoint.
An error occurred when retrieving data from the connector endpoint.
An internal service error occurred during the processing of your request. Try again later.
The resource specified in the request (such as the source or destination connector profile) is not found.
The request would cause a service quota (such as the number of flows) to be exceeded.
The request has invalid or missing parameters.
Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon AppFlow catalogs your data, it stores metadata in a data catalog.
Contains information about the configuration of the source connector used in the flow.
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
API calls have exceeded the maximum allowed API request rate per account and per Region.
Defines the connector-specific configuration and credentials for the connector profile.
The requested operation is not supported for the current flow.
Updates an existing flow.
Updates an existing flow.
module UpdateConnectorRegistrationResponse =
Awso_appflow.Values.UpdateConnectorRegistrationResponseUpdates 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
module UpdateConnectorRegistrationRequest =
Awso_appflow.Values.UpdateConnectorRegistrationRequestUpdates 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
Updates a given connector profile associated with your account.
Updates a given connector profile associated with your account.
Removes a tag from the specified flow.
Removes a tag from the specified flow.
Unregisters the custom connector registered in your account that matches the connector label provided in the request.
Unregisters the custom connector registered in your account that matches the connector label provided in the request.
Applies a tag to the specified flow.
Applies a tag to the specified flow.
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.
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.
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.
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.
module ResetConnectorMetadataCacheResponse =
Awso_appflow.Values.ResetConnectorMetadataCacheResponseResets 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.
module ResetConnectorMetadataCacheRequest =
Awso_appflow.Values.ResetConnectorMetadataCacheRequestResets 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.
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.
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.
Retrieves the tags that are associated with a specified flow.
Retrieves the tags that are associated with a specified flow.
Lists all of the flows associated with your account.
Lists all of the flows associated with your account.
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.
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.
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.
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.
Provides a description of the specified flow.
Provides a description of the specified flow.
module DescribeFlowExecutionRecordsResponse =
Awso_appflow.Values.DescribeFlowExecutionRecordsResponseFetches the execution history of the flow.
module DescribeFlowExecutionRecordsRequest =
Awso_appflow.Values.DescribeFlowExecutionRecordsRequestFetches the execution history of the flow.
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.
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.
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.
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.
module DescribeConnectorProfilesResponse =
Awso_appflow.Values.DescribeConnectorProfilesResponseReturns 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.
module DescribeConnectorProfilesRequest =
Awso_appflow.Values.DescribeConnectorProfilesRequestReturns 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.
Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
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.
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.
Enables you to delete an existing connector profile.
Enables you to delete an existing connector profile.
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.
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.
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.
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.
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.
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.