Skip to content

FlowDefinition

Used by
Source code in docs_src/capo_customer_profiles/types/flow_definition.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class FlowDefinition(TypedDict, closed=True):
    description: NotRequired[
        "capo_customer_profiles.types.flow_description.FlowDescription"
    ]
    """<p>A description of the flow you want to create.</p>"""
    flow_name: "capo_customer_profiles.types.flow_name.FlowName"
    """<p>The specified name of the flow. Use underscores (_) or hyphens (-) only. Spaces are not allowed.</p>"""
    kms_arn: "capo_customer_profiles.types.kms_arn.KmsArn"
    """<p>The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.</p>"""
    source_flow_config: (
        "capo_customer_profiles.types.source_flow_config.SourceFlowConfig"
    )
    """<p>The configuration that controls how Customer Profiles retrieves data from the source.</p>"""
    tasks: "capo_customer_profiles.types.tasks.Tasks"
    """<p>A list of tasks that Customer Profiles performs while transferring the data in the flow run.</p>"""
    trigger_config: "capo_customer_profiles.types.trigger_config.TriggerConfig"
    """<p>The trigger settings that determine how and when the flow runs.</p>"""

description instance-attribute 

description: NotRequired[FlowDescription]

A description of the flow you want to create.

flow_name instance-attribute 

flow_name: FlowName

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

kms_arn instance-attribute 

kms_arn: KmsArn

The Amazon Resource Name of the AWS Key Management Service (KMS) key you provide for encryption.

source_flow_config instance-attribute 

source_flow_config: SourceFlowConfig

The configuration that controls how Customer Profiles retrieves data from the source.

tasks instance-attribute 

tasks: Tasks

A list of tasks that Customer Profiles performs while transferring the data in the flow run.

trigger_config instance-attribute 

trigger_config: TriggerConfig

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