CreateFlowRequest ¶

class CreateFlowRequest(TypedDict, closed=True):
    flow_name: "capo_appflow.types.flow_name.FlowName"
    """<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>"""
    description: NotRequired["capo_appflow.types.flow_description.FlowDescription"]
    """<p> A description of the flow you want to create. </p>"""
    kms_arn: NotRequired["capo_appflow.types.kms_arn.KMSArn"]
    """<p> 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. </p>"""
    trigger_config: "capo_appflow.types.trigger_config.TriggerConfig"
    """<p> The trigger settings that determine how and when the flow runs. </p>"""
    source_flow_config: "capo_appflow.types.source_flow_config.SourceFlowConfig"
    """<p> The configuration that controls how Amazon AppFlow retrieves data from the source connector. </p>"""
    destination_flow_config_list: (
        "capo_appflow.types.destination_flow_config_list.DestinationFlowConfigList"
    )
    """<p> The configuration that controls how Amazon AppFlow places data in the destination connector. </p>"""
    tasks: "capo_appflow.types.tasks.Tasks"
    """<p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow run. </p>"""
    tags: NotRequired["capo_appflow.types.tag_map.TagMap"]
    """<p> The tags used to organize, track, or control access for your flow. </p>"""
    metadata_catalog_config: NotRequired[
        "capo_appflow.types.metadata_catalog_config.MetadataCatalogConfig"
    ]
    """<p>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.</p>"""
    client_token: NotRequired["capo_appflow.types.client_token.ClientToken"]
    """<p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>CreateFlow</code> 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 <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> 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.</p> <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>CreateFlow</code>. The token is active for 8 hours.</p>"""