Skip to content

UpdateConfiguredTableInput

Source code in docs_src/capo_cleanrooms/types/update_configured_table_input.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class UpdateConfiguredTableInput(TypedDict, closed=True):
    configured_table_identifier: (
        "capo_cleanrooms.types.configured_table_identifier.ConfiguredTableIdentifier"
    )
    """<p>The identifier for the configured table to update. Currently accepts the configured table ID.</p>"""
    name: NotRequired["capo_cleanrooms.types.display_name.DisplayName"]
    """<p>A new name for the configured table.</p>"""
    description: NotRequired["capo_cleanrooms.types.table_description.TableDescription"]
    """<p>A new description for the configured table.</p>"""
    table_reference: NotRequired["capo_cleanrooms.types.table_reference.TableReference"]
    allowed_columns: NotRequired[
        "capo_cleanrooms.types.allowed_column_list.AllowedColumnList"
    ]
    """<p>The columns of the underlying table that can be used by collaborations or analysis rules.</p>"""
    analysis_method: NotRequired["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>"""
    selected_analysis_methods: NotRequired[
        "capo_cleanrooms.types.selected_analysis_methods.SelectedAnalysisMethods"
    ]
    """<p> The selected analysis methods for the table configuration update.</p>"""

allowed_columns instance-attribute 

allowed_columns: NotRequired[AllowedColumnList]

The columns of the underlying table that can be used by collaborations or analysis rules.

analysis_method instance-attribute 

analysis_method: NotRequired[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.

configured_table_identifier instance-attribute 

configured_table_identifier: ConfiguredTableIdentifier

The identifier for the configured table to update. Currently accepts the configured table ID.

description instance-attribute 

description: NotRequired[TableDescription]

A new description for the configured table.

name instance-attribute 

name: NotRequired[DisplayName]

A new name for the configured table.

selected_analysis_methods instance-attribute 

selected_analysis_methods: NotRequired[SelectedAnalysisMethods]

The selected analysis methods for the table configuration update.

table_reference instance-attribute 

table_reference: NotRequired[TableReference]