Skip to content

ConfiguredTable

Source code in docs_src/capo_cleanrooms/types/configured_table.py
class ConfiguredTable(TypedDict, closed=True):
    id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID for the configured table.</p>"""
    arn: "capo_cleanrooms.types.configured_table_arn.ConfiguredTableArn"
    """<p>The unique ARN for the configured table.</p>"""
    name: "capo_cleanrooms.types.display_name.DisplayName"
    """<p>A name for the configured table.</p>"""
    description: NotRequired["capo_cleanrooms.types.table_description.TableDescription"]
    """<p>A description for the configured table.</p>"""
    table_reference: "capo_cleanrooms.types.table_reference.TableReference"
    """<p>The table that this configured table represents.</p>"""
    create_time: "datetime.datetime"
    """<p>The time the configured table was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The time the configured table was last updated</p>"""
    analysis_rule_types: "capo_cleanrooms.types.configured_table_analysis_rule_type_list.ConfiguredTableAnalysisRuleTypeList"
    """<p>The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.</p>"""
    analysis_method: "capo_cleanrooms.types.analysis_method.AnalysisMethod"
    """<p>The analysis method for the configured table.</p> <p> <code>DIRECT_QUERY</code> allows SQL queries to be run directly on this table.</p> <p> <code>DIRECT_JOB</code> allows PySpark jobs to be run directly on this table.</p> <p> <code>MULTIPLE</code> allows both SQL queries and PySpark jobs to be run directly on this table.</p>"""
    allowed_columns: "capo_cleanrooms.types.allowed_column_list.AllowedColumnList"
    """<p>The columns within the underlying Glue table that can be used within collaborations.</p>"""
    selected_analysis_methods: NotRequired[
        "capo_cleanrooms.types.selected_analysis_methods.SelectedAnalysisMethods"
    ]
    """<p> The selected analysis methods for the configured table.</p>"""

allowed_columns instance-attribute

allowed_columns: AllowedColumnList

The columns within the underlying Glue table that can be used within collaborations.

analysis_method instance-attribute

analysis_method: AnalysisMethod

The analysis method for the configured table.

DIRECT_QUERY allows SQL queries to be run directly on this table.

DIRECT_JOB allows PySpark jobs to be run directly on this table.

MULTIPLE allows both SQL queries and PySpark jobs to be run directly on this table.

analysis_rule_types instance-attribute

The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

arn instance-attribute

The unique ARN for the configured table.

create_time instance-attribute

create_time: datetime

The time the configured table was created.

description instance-attribute

description: NotRequired[TableDescription]

A description for the configured table.

id instance-attribute

id: UUID

The unique ID for the configured table.

name instance-attribute

A name for the configured table.

selected_analysis_methods instance-attribute

selected_analysis_methods: NotRequired[SelectedAnalysisMethods]

The selected analysis methods for the configured table.

table_reference instance-attribute

table_reference: TableReference

The table that this configured table represents.

update_time instance-attribute

update_time: datetime

The time the configured table was last updated