Skip to content

SchemaStatusDetail

Source code in docs_src/capo_cleanrooms/types/schema_status_detail.py
class SchemaStatusDetail(TypedDict, closed=True):
    status: "capo_cleanrooms.types.schema_status.SchemaStatus"
    """<p>The status of the schema, indicating if it is ready to query.</p>"""
    reasons: NotRequired[
        "capo_cleanrooms.types.schema_status_reason_list.SchemaStatusReasonList"
    ]
    """<p>The reasons why the schema status is set to its current state.</p>"""
    analysis_rule_type: NotRequired[
        "capo_cleanrooms.types.analysis_rule_type.AnalysisRuleType"
    ]
    """<p>The analysis rule type for which the schema status has been evaluated.</p>"""
    configurations: NotRequired[
        "capo_cleanrooms.types.schema_configuration_list.SchemaConfigurationList"
    ]
    """<p>The configuration details of the schema analysis rule for the given type.</p>"""
    analysis_type: "capo_cleanrooms.types.analysis_type.AnalysisType"
    """<p>The type of analysis that can be performed on the schema.</p> <p>A schema can have an <code>analysisType</code> of <code>DIRECT_ANALYSIS</code>, <code>ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION</code>, or both.</p>"""

analysis_rule_type instance-attribute

analysis_rule_type: NotRequired[AnalysisRuleType]

The analysis rule type for which the schema status has been evaluated.

analysis_type instance-attribute

analysis_type: AnalysisType

The type of analysis that can be performed on the schema.

A schema can have an analysisType of DIRECT_ANALYSIS, ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.

configurations instance-attribute

configurations: NotRequired[SchemaConfigurationList]

The configuration details of the schema analysis rule for the given type.

reasons instance-attribute

reasons: NotRequired[SchemaStatusReasonList]

The reasons why the schema status is set to its current state.

status instance-attribute

status: SchemaStatus

The status of the schema, indicating if it is ready to query.