Skip to content

ProfileConfiguration

Source code in docs_src/capo_databrew/types/profile_configuration.py
class ProfileConfiguration(TypedDict, closed=True):
    dataset_statistics_configuration: NotRequired[
        "capo_databrew.types.statistics_configuration.StatisticsConfiguration"
    ]
    """<p>Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations. </p>"""
    profile_columns: NotRequired[
        "capo_databrew.types.column_selector_list.ColumnSelectorList"
    ]
    """<p>List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns. </p>"""
    column_statistics_configurations: NotRequired[
        "capo_databrew.types.column_statistics_configuration_list.ColumnStatisticsConfigurationList"
    ]
    """<p>List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations. </p>"""
    entity_detector_configuration: NotRequired[
        "capo_databrew.types.entity_detector_configuration.EntityDetectorConfiguration"
    ]
    """<p>Configuration of entity detection for a profile job. When undefined, entity detection is disabled.</p>"""

column_statistics_configurations instance-attribute

column_statistics_configurations: NotRequired[ColumnStatisticsConfigurationList]

List of configurations for column evaluations. ColumnStatisticsConfigurations are used to select evaluations and override parameters of evaluations for particular columns. When ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns and run all supported evaluations.

dataset_statistics_configuration instance-attribute

dataset_statistics_configuration: NotRequired[StatisticsConfiguration]

Configuration for inter-column evaluations. Configuration can be used to select evaluations and override parameters of evaluations. When configuration is undefined, the profile job will run all supported inter-column evaluations.

entity_detector_configuration instance-attribute

entity_detector_configuration: NotRequired[EntityDetectorConfiguration]

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

profile_columns instance-attribute

profile_columns: NotRequired[ColumnSelectorList]

List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.