Skip to content

Schema

Source code in docs_src/capo_cleanrooms/types/schema.py
class Schema(TypedDict, closed=True):
    columns: "capo_cleanrooms.types.column_list.ColumnList"
    """<p>The columns for the relation that this schema represents.</p>"""
    partition_keys: "capo_cleanrooms.types.column_list.ColumnList"
    """<p>The partition keys for the dataset underlying this schema.</p>"""
    analysis_rule_types: (
        "capo_cleanrooms.types.analysis_rule_type_list.AnalysisRuleTypeList"
    )
    """<p>The analysis rule types that are associated with the schema. Currently, only one entry is present.</p>"""
    analysis_method: NotRequired["capo_cleanrooms.types.analysis_method.AnalysisMethod"]
    """<p>The analysis method for the schema. </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 schema.</p>"""
    creator_account_id: "capo_cleanrooms.types.account_id.AccountId"
    """<p>The unique account ID for the Amazon Web Services account that owns the schema.</p>"""
    name: "capo_cleanrooms.types.table_alias.TableAlias"
    """<p>A name for the schema. The schema relation is referred to by this name when queried by a protected query.</p>"""
    collaboration_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID for the collaboration that the schema belongs to.</p>"""
    collaboration_arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.</p>"""
    description: "capo_cleanrooms.types.table_description.TableDescription"
    """<p>A description for the schema.</p>"""
    create_time: "datetime.datetime"
    """<p>The time at which the schema was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The most recent time at which the schema was updated.</p>"""
    type: "capo_cleanrooms.types.schema_type.SchemaType"
    """<p>The type of schema.</p>"""
    schema_status_details: (
        "capo_cleanrooms.types.schema_status_detail_list.SchemaStatusDetailList"
    )
    """<p>Details about the status of the schema. Currently, only one entry is present.</p>"""
    resource_arn: NotRequired[
        "capo_cleanrooms.types.schema_resource_arn.SchemaResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the schema resource.</p>"""
    schema_type_properties: NotRequired[
        "capo_cleanrooms.types.schema_type_properties.SchemaTypeProperties"
    ]
    """<p>The schema type properties.</p>"""

analysis_method instance-attribute

analysis_method: NotRequired[AnalysisMethod]

The analysis method for the schema.

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

analysis_rule_types: AnalysisRuleTypeList

The analysis rule types that are associated with the schema. Currently, only one entry is present.

collaboration_arn instance-attribute

collaboration_arn: CollaborationArn

The unique Amazon Resource Name (ARN) for the collaboration that the schema belongs to.

collaboration_id instance-attribute

collaboration_id: UUID

The unique ID for the collaboration that the schema belongs to.

columns instance-attribute

columns: ColumnList

The columns for the relation that this schema represents.

create_time instance-attribute

create_time: datetime

The time at which the schema was created.

creator_account_id instance-attribute

creator_account_id: AccountId

The unique account ID for the Amazon Web Services account that owns the schema.

description instance-attribute

description: TableDescription

A description for the schema.

name instance-attribute

name: TableAlias

A name for the schema. The schema relation is referred to by this name when queried by a protected query.

partition_keys instance-attribute

partition_keys: ColumnList

The partition keys for the dataset underlying this schema.

resource_arn instance-attribute

resource_arn: NotRequired[SchemaResourceArn]

The Amazon Resource Name (ARN) of the schema resource.

schema_status_details instance-attribute

schema_status_details: SchemaStatusDetailList

Details about the status of the schema. Currently, only one entry is present.

schema_type_properties instance-attribute

schema_type_properties: NotRequired[SchemaTypeProperties]

The schema type properties.

selected_analysis_methods instance-attribute

selected_analysis_methods: NotRequired[SelectedAnalysisMethods]

The selected analysis methods for the schema.

type instance-attribute

type: SchemaType

The type of schema.

update_time instance-attribute

update_time: datetime

The most recent time at which the schema was updated.