Module Awso_appflow.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule ConnectorSuppliedValue : sig ... end
Sourcemodule PathPrefix : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule Key : sig ... end
Sourcemodule Label : sig ... end
Sourcemodule AggregationType : sig ... end
Sourcemodule Long : sig ... end
Sourcemodule PathPrefixHierarchy : sig ... end
Sourcemodule PrefixFormat : sig ... end
Sourcemodule PrefixType : sig ... end
Sourcemodule AuthParameter : sig ... end

Information about required authentication parameters.

Sourcemodule OAuth2CustomPropType : sig ... end
Sourcemodule CustomPropertyKey : sig ... end
Sourcemodule CustomPropertyValue : sig ... end
Sourcemodule OAuthScope : sig ... end
Sourcemodule BucketName : sig ... end
Sourcemodule BucketPrefix : sig ... end
Sourcemodule Name : sig ... end
Sourcemodule AggregationConfig : sig ... end

The aggregation settings that you can use to customize the output format of your flow data.

Sourcemodule FileType : sig ... end
Sourcemodule JavaBoolean : sig ... end
Sourcemodule PrefixConfig : sig ... end

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow destination.

Sourcemodule CredentialsMapKey : sig ... end
Sourcemodule CredentialsMapValue : sig ... end
Sourcemodule AuthCode : sig ... end
Sourcemodule RedirectUri : sig ... end
Sourcemodule ExecutionStatus : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule AuthParameterList : sig ... end
Sourcemodule CustomAuthenticationType : sig ... end
Sourcemodule AuthCodeUrl : sig ... end
Sourcemodule OAuth2CustomParameter : sig ... end

Custom parameter required for OAuth 2.0 authentication.

Sourcemodule OAuth2GrantType : sig ... end
Sourcemodule TokenUrl : sig ... end
Sourcemodule SalesforceDataTransferApi : sig ... end
Sourcemodule Region : sig ... end
Sourcemodule TokenUrlCustomProperties : sig ... end
Sourcemodule ProfilePropertyKey : sig ... end
Sourcemodule ProfilePropertyValue : sig ... end
Sourcemodule OAuthScopeList : sig ... end
Sourcemodule Operator : sig ... end
Sourcemodule Double : sig ... end
Sourcemodule Value : sig ... end
Sourcemodule CustomProperties : sig ... end
Sourcemodule EntityName : sig ... end
Sourcemodule ErrorHandlingConfig : sig ... end

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.

Sourcemodule IdFieldNameList : sig ... end
Sourcemodule WriteOperationType : sig ... end
Sourcemodule DomainName : sig ... end
Sourcemodule ObjectTypeName : sig ... end
Sourcemodule Object : sig ... end
Sourcemodule S3OutputFormatConfig : sig ... end

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.

Sourcemodule UpsolverBucketName : sig ... end

The configuration that determines how Amazon AppFlow formats the flow output data when Upsolver is used as the destination.

Sourcemodule DataTransferApiType : sig ... end
Sourcemodule DataTransferApiTypeName : sig ... end
Sourcemodule S3InputFileType : sig ... end
Sourcemodule SAPODataMaxPageSize : sig ... end
Sourcemodule SAPODataMaxParallelism : sig ... end
Sourcemodule ApiKey : sig ... end
Sourcemodule ApiSecretKey : sig ... end
Sourcemodule Password : sig ... end
Sourcemodule Username : sig ... end
Sourcemodule CredentialsMap : sig ... end
Sourcemodule AccessToken : sig ... end
Sourcemodule ClientId : sig ... end
Sourcemodule ClientSecret : sig ... end
Sourcemodule ConnectorOAuthRequest : sig ... end

Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.

Sourcemodule RefreshToken : sig ... end
Sourcemodule ExecutionMessage : sig ... end
Sourcemodule CatalogType : sig ... end
Sourcemodule RegistrationOutput : sig ... end

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.

Sourcemodule CustomAuthConfig : sig ... end

Configuration information required for custom authentication.

Sourcemodule AuthCodeUrlList : sig ... end
Sourcemodule TokenUrlList : sig ... end
Sourcemodule RegionList : sig ... end
Sourcemodule ARN : sig ... end
Sourcemodule OAuth2Properties : sig ... end

The OAuth 2.0 properties required for OAuth 2.0 authentication.

Sourcemodule ProfilePropertiesMap : sig ... end
Sourcemodule InstanceUrl : sig ... end
Sourcemodule BusinessUnitId : sig ... end
Sourcemodule ClusterIdentifier : sig ... end
Sourcemodule DataApiRoleArn : sig ... end
Sourcemodule DatabaseName : sig ... end
Sourcemodule DatabaseUrl : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule WorkgroupName : sig ... end
Sourcemodule ApplicationHostUrl : sig ... end
Sourcemodule ApplicationServicePath : sig ... end
Sourcemodule ClientNumber : sig ... end
Sourcemodule LogonLanguage : sig ... end
Sourcemodule OAuthProperties : sig ... end

The OAuth properties required for OAuth type authentication.

Sourcemodule PortNumber : sig ... end
Sourcemodule PrivateLinkServiceName : sig ... end
Sourcemodule AccountName : sig ... end
Sourcemodule Stage : sig ... end
Sourcemodule Warehouse : sig ... end
Sourcemodule FieldType : sig ... end
Sourcemodule FilterOperatorList : sig ... end
Sourcemodule Range : sig ... end

The range of values that the property supports.

Sourcemodule SupportedValueList : sig ... end

The properties that are applied when the custom connector is being used as a destination.

The properties that are applied when Amazon Connect Customer Profiles is used as a destination.

The 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.

The 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.

Sourcemodule S3DestinationProperties : sig ... end

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.

Sourcemodule DataTransferApi : sig ... end

The API of the connector application that Amazon AppFlow uses to transfer your data.

Sourcemodule S3InputFormatConfig : sig ... end

When you use Amazon S3 as the source, the configuration format that you provide the flow input data.

Sourcemodule SAPODataPaginationConfig : sig ... end

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.

Sourcemodule SAPODataParallelismConfig : sig ... end

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.

Sourcemodule DocumentType : sig ... end
Sourcemodule DatadogConnectorOperator : sig ... end
Sourcemodule MarketoConnectorOperator : sig ... end
Sourcemodule PardotConnectorOperator : sig ... end
Sourcemodule S3ConnectorOperator : sig ... end
Sourcemodule SAPODataConnectorOperator : sig ... end
Sourcemodule SingularConnectorOperator : sig ... end
Sourcemodule SlackConnectorOperator : sig ... end
Sourcemodule VeevaConnectorOperator : sig ... end
Sourcemodule ZendeskConnectorOperator : sig ... end
Sourcemodule OperatorPropertiesKeys : sig ... end
Sourcemodule Property : sig ... end
Sourcemodule DataPullMode : sig ... end
Sourcemodule Date : sig ... end
Sourcemodule ScheduleExpression : sig ... end
Sourcemodule ScheduleOffset : sig ... end
Sourcemodule Timezone : sig ... end
Sourcemodule SecretKey : sig ... end
Sourcemodule ApiKeyCredentials : sig ... end

The API key credentials required for API key authentication.

Sourcemodule AuthenticationType : sig ... end
Sourcemodule BasicAuthCredentials : sig ... end

The basic auth credentials required for basic authentication.

Sourcemodule CustomAuthCredentials : sig ... end

The custom credentials required for custom authentication.

Sourcemodule OAuth2Credentials : sig ... end

The OAuth 2.0 credentials required for OAuth 2.0 authentication.

Sourcemodule ApplicationKey : sig ... end
Sourcemodule ApiToken : sig ... end
Sourcemodule AccessKeyId : sig ... end
Sourcemodule ClientCredentialsArn : sig ... end
Sourcemodule OAuthCredentials : sig ... end

The OAuth credentials required for OAuth type authentication.

Sourcemodule JwtToken : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule ConnectorMode : sig ... end
Sourcemodule SupportedDataTransferType : sig ... end
Sourcemodule ErrorInfo : sig ... end

Provides details in the event of a failed flow, including the failure count and the related error messages.

Sourcemodule MetadataCatalogDetail : sig ... end

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.

Sourcemodule CustomAuthConfigList : sig ... end
Sourcemodule OAuth2Defaults : sig ... end

Contains the default values required for OAuth 2.0 authentication.

Sourcemodule AmplitudeMetadata : sig ... end

The connector metadata specific to Amplitude.

Sourcemodule CustomerProfilesMetadata : sig ... end

The connector metadata specific to Amazon Connect Customer Profiles.

Sourcemodule DatadogMetadata : sig ... end

The connector metadata specific to Datadog.

Sourcemodule DynatraceMetadata : sig ... end

The connector metadata specific to Dynatrace.

Sourcemodule EventBridgeMetadata : sig ... end

The connector metadata specific to Amazon EventBridge.

Sourcemodule GoogleAnalyticsMetadata : sig ... end

The connector metadata specific to Google Analytics.

Sourcemodule HoneycodeMetadata : sig ... end

The connector metadata specific to Amazon Honeycode.

Sourcemodule InforNexusMetadata : sig ... end

The connector metadata specific to Infor Nexus.

Sourcemodule MarketoMetadata : sig ... end

The connector metadata specific to Marketo.

Sourcemodule PardotMetadata : sig ... end

The connector metadata specific to Salesforce Pardot.

Sourcemodule RedshiftMetadata : sig ... end

The connector metadata specific to Amazon Redshift.

Sourcemodule S3Metadata : sig ... end

The connector metadata specific to Amazon S3.

Sourcemodule SAPODataMetadata : sig ... end

The connector metadata specific to SAPOData.

Sourcemodule SalesforceMetadata : sig ... end

The connector metadata specific to Salesforce.

Sourcemodule ServiceNowMetadata : sig ... end

The connector metadata specific to ServiceNow.

Sourcemodule SingularMetadata : sig ... end

The connector metadata specific to Singular.

Sourcemodule SlackMetadata : sig ... end

The connector metadata specific to Slack.

Sourcemodule SnowflakeMetadata : sig ... end

The connector metadata specific to Snowflake.

Sourcemodule TrendmicroMetadata : sig ... end

The connector metadata specific to Trend Micro.

Sourcemodule UpsolverMetadata : sig ... end

The connector metadata specific to Upsolver.

Sourcemodule VeevaMetadata : sig ... end

The connector metadata specific to Veeva.

Sourcemodule ZendeskMetadata : sig ... end

The connector metadata specific to Zendesk.

Contains information about the configuration of the lambda which is being registered as the connector.

Sourcemodule ConnectorRuntimeSetting : sig ... end

Contains information about the connector runtime settings that are required for flow execution.

Sourcemodule ConnectorType : sig ... end
Sourcemodule ScheduleFrequencyType : sig ... end
Sourcemodule SupportedApiVersion : sig ... end
Sourcemodule Operators : sig ... end
Sourcemodule TriggerType : sig ... end

The connector-specific profile properties required when using Amplitude.

The profile properties required by the custom connector.

The connector-specific profile properties required by Datadog.

The connector-specific profile properties required by Dynatrace.

The connector-specific profile properties required by Google Analytics.

The connector-specific properties required when using Amazon Honeycode.

The connector-specific profile properties required by Infor Nexus.

The connector-specific profile properties required when using Marketo.

The connector-specific profile properties required when using Salesforce Pardot.

The connector-specific profile properties when using Amazon Redshift.

The connector-specific profile properties required when using SAPOData.

The connector-specific profile properties required when using Salesforce.

The connector-specific profile properties required when using ServiceNow.

The connector-specific profile properties required when using Singular.

The connector-specific profile properties required when using Slack.

The connector-specific profile properties required when using Snowflake.

The connector-specific profile properties required when using Trend Micro.

The connector-specific profile properties required when using Veeva.

The connector-specific profile properties required when using Zendesk.

Sourcemodule FieldTypeDetails : sig ... end

Contains details regarding the supported field type and the operators that can be applied for filtering.

Sourcemodule ApiVersion : sig ... end
Sourcemodule ConnectorProfileName : sig ... end

This stores the information that is required to query a particular connector.

Sourcemodule GlueDataCatalogIAMRole : sig ... end
Sourcemodule DatetimeTypeFieldName : sig ... end
Sourcemodule AmplitudeSourceProperties : sig ... end

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.

Sourcemodule DatadogSourceProperties : sig ... end

The properties that are applied when Datadog is being used as a source.

Sourcemodule DynatraceSourceProperties : sig ... end

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.

Sourcemodule MarketoSourceProperties : sig ... end

The properties that are applied when Marketo is being used as a source.

Sourcemodule PardotSourceProperties : sig ... end

The properties that are applied when Salesforce Pardot is being used as a source.

Sourcemodule S3SourceProperties : sig ... end

The properties that are applied when Amazon S3 is being used as the flow source.

Sourcemodule SAPODataSourceProperties : sig ... end

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.

Sourcemodule SingularSourceProperties : sig ... end

The properties that are applied when Singular is being used as a source.

Sourcemodule SlackSourceProperties : sig ... end

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.

Sourcemodule VeevaSourceProperties : sig ... end

The properties that are applied when using Veeva as a flow source.

Sourcemodule ZendeskSourceProperties : sig ... end

The properties that are applied when using Zendesk as a flow source.

Sourcemodule ConnectorOperator : sig ... end

The operation to be performed on the provided source fields.

Sourcemodule DestinationField : sig ... end
Sourcemodule SourceFields : sig ... end
Sourcemodule TaskPropertiesMap : sig ... end
Sourcemodule TaskType : sig ... end

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

The connector-specific credentials required when using Amplitude.

The connector-specific profile credentials that are required when using the custom connector.

The connector-specific credentials required by Datadog.

The connector-specific profile credentials required by Dynatrace.

The connector-specific profile credentials required by Google Analytics.

The connector-specific credentials required when using Amazon Honeycode.

The connector-specific profile credentials required by Infor Nexus.

The connector-specific profile credentials required by Marketo.

The connector-specific profile credentials required when using Salesforce Pardot.

The connector-specific profile credentials required when using Amazon Redshift.

The connector-specific profile credentials required when using SAPOData.

The connector-specific profile credentials required when using Salesforce.

The connector-specific profile credentials required when using ServiceNow.

The connector-specific profile credentials required when using Singular.

The connector-specific profile credentials required when using Slack.

The connector-specific profile credentials required when using Snowflake.

The connector-specific profile credentials required when using Trend Micro.

The connector-specific profile credentials required when using Veeva.

The connector-specific profile credentials required when using Zendesk.

Sourcemodule ConnectorLabel : sig ... end
Sourcemodule CreatedBy : sig ... end
Sourcemodule ExecutionDetails : sig ... end

Describes the details of the flow run, including the timestamp, status, and message.

Sourcemodule FlowArn : sig ... end
Sourcemodule FlowDescription : sig ... end
Sourcemodule FlowName : sig ... end
Sourcemodule FlowStatus : sig ... end
Sourcemodule TagMap : sig ... end
Sourcemodule UpdatedBy : sig ... end
Sourcemodule ApplicationType : sig ... end
Sourcemodule ConnectorDescription : sig ... end
Sourcemodule ConnectorModeList : sig ... end
Sourcemodule ConnectorName : sig ... end
Sourcemodule ConnectorOwner : sig ... end
Sourcemodule ConnectorProvisioningType : sig ... end
Sourcemodule ConnectorVersion : sig ... end
Sourcemodule RegisteredBy : sig ... end
Sourcemodule ConnectorEntity : sig ... end

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.

Sourcemodule ExecutionId : sig ... end
Sourcemodule ExecutionResult : sig ... end

Specifies the end result of the flow run.

Sourcemodule MetadataCatalogDetails : sig ... end
Sourcemodule AuthenticationConfig : sig ... end

Contains information about the authentication config that the connector supports.

Sourcemodule ConnectorMetadata : sig ... end

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.

Sourcemodule ConnectorTypeList : sig ... end
Sourcemodule LogoURL : sig ... end
Sourcemodule SupportedApiVersionList : sig ... end
Sourcemodule SupportedDataTransferApis : sig ... end
Sourcemodule SupportedOperatorList : sig ... end
Sourcemodule TriggerTypeList : sig ... end
Sourcemodule ConnectionMode : sig ... end
Sourcemodule ConnectorProfileArn : sig ... end

The connector-specific profile properties required by each connector.

Specifies the private connection provisioning state.

The properties that can be applied to a field when connector is being used as a destination.

Sourcemodule Identifier : sig ... end
Sourcemodule SourceFieldProperties : sig ... end

The properties that can be applied to a field when the connector is being used as a source.

Sourcemodule SupportedFieldTypeDetails : sig ... end

Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.

Sourcemodule ErrorMessage : sig ... end
Sourcemodule DestinationFlowConfig : sig ... end

Contains information about the configuration of destination connectors present in the flow.

Sourcemodule GlueDataCatalogConfig : sig ... end

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.

Sourcemodule IncrementalPullConfig : sig ... end

Specifies the configuration used when importing incremental records from the source.

Sourcemodule SourceConnectorProperties : sig ... end

Specifies the information that is required to query a particular connector.

Sourcemodule Task : sig ... end

A class for modeling different type of tasks. Task implementation varies based on the TaskType.

Sourcemodule TriggerProperties : sig ... end

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.

Sourcemodule FlowDefinition : sig ... end

The properties of the flow, such as its source, destination, trigger type, and so on.

Sourcemodule ConnectorDetail : sig ... end

Information about the registered connector.

Sourcemodule ConnectorEntityList : sig ... end
Sourcemodule Group : sig ... end
Sourcemodule ExecutionRecord : sig ... end

Specifies information about the past flow run instances for a given flow.

Sourcemodule ConnectorConfiguration : sig ... end

The configuration settings related to a given connector.

Sourcemodule ConnectorProfile : sig ... end

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.

Sourcemodule ConnectorEntityField : sig ... end

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.

Sourcemodule AccessDeniedException : sig ... end

AppFlow/Requester has invalid or missing permissions.

Sourcemodule ConflictException : sig ... end

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.

An error occurred when authenticating with the connector endpoint.

Sourcemodule ConnectorServerException : sig ... end

An error occurred when retrieving data from the connector endpoint.

Sourcemodule InternalServerException : sig ... end

An internal service error occurred during the processing of your request. Try again later.

Sourcemodule ResourceNotFoundException : sig ... end

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.

Sourcemodule ValidationException : sig ... end

The request has invalid or missing parameters.

Sourcemodule ClientToken : sig ... end
Sourcemodule DestinationFlowConfigList : sig ... end
Sourcemodule MetadataCatalogConfig : sig ... end

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.

Sourcemodule SourceFlowConfig : sig ... end

Contains information about the configuration of the source connector used in the flow.

Sourcemodule Tasks : sig ... end
Sourcemodule TriggerConfig : sig ... end

The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Sourcemodule ThrottlingException : sig ... end

API calls have exceeded the maximum allowed API request rate per account and per Region.

Sourcemodule ConnectorProfileConfig : sig ... end

Defines the connector-specific configuration and credentials for the connector profile.

Sourcemodule TagKeyList : sig ... end

The requested operation is not supported for the current flow.

Sourcemodule EntitiesPath : sig ... end
Sourcemodule FlowList : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule ConnectorList : sig ... end
Sourcemodule ConnectorEntityMap : sig ... end
Sourcemodule ListEntitiesMaxResults : sig ... end
Sourcemodule FlowStatusMessage : sig ... end
Sourcemodule KMSArn : sig ... end
Sourcemodule FlowExecutionList : sig ... end
Sourcemodule ConnectorProfileNameList : sig ... end
Sourcemodule ConnectorEntityFieldList : sig ... end
Sourcemodule ExecutionIds : sig ... end
Sourcemodule UpdateFlowResponse : sig ... end

Updates an existing flow.

Sourcemodule UpdateFlowRequest : sig ... end

Updates an existing flow.

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

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

Updates a given connector profile associated with your account.

Updates a given connector profile associated with your account.

Sourcemodule UntagResourceResponse : sig ... end

Removes a tag from the specified flow.

Sourcemodule UntagResourceRequest : sig ... end

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.

Sourcemodule TagResourceResponse : sig ... end

Applies a tag to the specified flow.

Sourcemodule TagResourceRequest : sig ... end

Applies a tag to the specified flow.

Sourcemodule StopFlowResponse : sig ... end

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.

Sourcemodule StopFlowRequest : sig ... end

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.

Sourcemodule StartFlowResponse : sig ... end

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.

Sourcemodule StartFlowRequest : sig ... end

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.

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.

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.

Sourcemodule RegisterConnectorResponse : sig ... end

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.

Sourcemodule RegisterConnectorRequest : sig ... end

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.

Sourcemodule ListFlowsResponse : sig ... end

Lists all of the flows associated with your account.

Sourcemodule ListFlowsRequest : sig ... end

Lists all of the flows associated with your account.

Sourcemodule ListConnectorsResponse : sig ... end

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.

Sourcemodule ListConnectorsRequest : sig ... end

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.

Sourcemodule DescribeFlowResponse : sig ... end

Provides a description of the specified flow.

Sourcemodule DescribeFlowRequest : sig ... end

Provides a description of the specified flow.

Fetches the execution history of the flow.

Fetches 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.

Sourcemodule DescribeConnectorsRequest : sig ... end

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.

Sourcemodule DescribeConnectorResponse : sig ... end

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.

Sourcemodule DescribeConnectorRequest : sig ... end

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.

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.

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.

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.

Sourcemodule DeleteFlowResponse : sig ... end

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.

Sourcemodule DeleteFlowRequest : sig ... end

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.

Sourcemodule CreateFlowResponse : sig ... end

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.

Sourcemodule CreateFlowRequest : sig ... end

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.