Module Values.CreateFlowRequestSource

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.

Sourcetype nonrec t = {
  1. flowName : FlowName.t;
    (*

    The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

    *)
  2. description : FlowDescription.t option;
    (*

    A description of the flow you want to create.

    *)
  3. kmsArn : KMSArn.t option;
    (*

    The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.

    *)
  4. triggerConfig : TriggerConfig.t;
    (*

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

    *)
  5. sourceFlowConfig : SourceFlowConfig.t;
    (*

    The configuration that controls how Amazon AppFlow retrieves data from the source connector.

    *)
  6. destinationFlowConfigList : DestinationFlowConfigList.t;
    (*

    The configuration that controls how Amazon AppFlow places data in the destination connector.

    *)
  7. tasks : Tasks.t;
    (*

    A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.

    *)
  8. tags : TagMap.t option;
    (*

    The tags used to organize, track, or control access for your flow.

    *)
  9. metadataCatalogConfig : MetadataCatalogConfig.t option;
    (*

    Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it stores metadata in a data catalog.

    *)
  10. clientToken : ClientToken.t option;
    (*

    The clientToken parameter is an idempotency token. It ensures that your CreateFlow request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value. If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases. If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The token is active for 8 hours.

    *)
}
Sourceval context_ : string
Sourceval make : ?description:??? -> ?kmsArn:??? -> ?tags:??? -> ?metadataCatalogConfig:??? -> ?clientToken:??? -> flowName:FlowName.t -> triggerConfig:TriggerConfig.t -> sourceFlowConfig:SourceFlowConfig.t -> destinationFlowConfigList:DestinationFlowConfigList.t -> tasks:Tasks.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `List of [> `Structure of (string * [> `Enum of string | `List of [> `String of String_.t ] list | `Map of ([> `Enum of string ] * [> `String of Property.t ]) list | `String of ApiVersion.t | `Structure of (string * [> `Enum of string | `Structure of (string * [> `Enum of string | `List of [> `String of Name.t ] list | `Map of ([> `String of CustomPropertyKey.t ] * [> `String of CustomPropertyValue.t ]) list | `String of Object.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `String of BucketPrefix.t | `Structure of (string * [> `Enum of string | `List of [> `Enum of string ] list | `Long of Long.t ]) list ]) list ]) list ]) list ]) list ] list | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of FlowName.t | `Structure of (string * [> `Enum of string | `String of ApiVersion.t | `Structure of (string * [> `String of DatetimeTypeFieldName.t | `Structure of (string * [> `Boolean of Boolean.t | `Enum of string | `Integer of FlowErrorDeactivationThreshold.t | `Long of ScheduleOffset.t | `Map of ([> `String of CustomPropertyKey.t ] * [> `String of CustomPropertyValue.t ]) list | `String of ScheduleExpression.t | `Structure of (string * [> `Enum of string | `Integer of SAPODataMaxParallelism.t | `String of DataTransferApiTypeName.t ]) list | `Timestamp of Date.t ]) list ]) list ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t