Skip to content

PrefixConfig

Source code in docs_src/capo_appflow/types/prefix_config.py 
13
14
15
16
17
18
19
20
21
class PrefixConfig(TypedDict, closed=True):
    prefix_type: NotRequired["capo_appflow.types.prefix_type.PrefixType"]
    """<p>Determines the format of the prefix, and whether it applies to the file name, file path, or both. </p>"""
    prefix_format: NotRequired["capo_appflow.types.prefix_format.PrefixFormat"]
    """<p>Determines the level of granularity for the date and time that's included in the prefix. </p>"""
    path_prefix_hierarchy: NotRequired[
        "capo_appflow.types.path_prefix_hierarchy.PathPrefixHierarchy"
    ]
    """<p>Specifies whether the destination file path includes either or both of the following elements:</p> <dl> <dt>EXECUTION_ID</dt> <dd> <p>The ID that Amazon AppFlow assigns to the flow run.</p> </dd> <dt>SCHEMA_VERSION</dt> <dd> <p>The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:</p> <ul> <li> <p>Source-to-destination field mappings</p> </li> <li> <p>Field data types</p> </li> <li> <p>Partition keys</p> </li> </ul> </dd> </dl>"""

path_prefix_hierarchy instance-attribute 

path_prefix_hierarchy: NotRequired[PathPrefixHierarchy]

Specifies whether the destination file path includes either or both of the following elements:

EXECUTION_ID

The ID that Amazon AppFlow assigns to the flow run.

SCHEMA_VERSION

The version number of your data schema. Amazon AppFlow assigns this version number. The version number increases by one when you change any of the following settings in your flow configuration:

  • Source-to-destination field mappings

  • Field data types

  • Partition keys

prefix_format instance-attribute 

prefix_format: NotRequired[PrefixFormat]

Determines the level of granularity for the date and time that's included in the prefix.

prefix_type instance-attribute 

prefix_type: NotRequired[PrefixType]

Determines the format of the prefix, and whether it applies to the file name, file path, or both.