Skip to content

StartProtectedQueryInput

Source code in docs_src/capo_cleanrooms/types/start_protected_query_input.py
class StartProtectedQueryInput(TypedDict, closed=True):
    type: "capo_cleanrooms.types.protected_query_type.ProtectedQueryType"
    """<p>The type of the protected query to be started.</p>"""
    membership_identifier: (
        "capo_cleanrooms.types.membership_identifier.MembershipIdentifier"
    )
    """<p>A unique identifier for the membership to run this query against. Currently accepts a membership ID.</p>"""
    sql_parameters: "capo_cleanrooms.types.protected_query_sql_parameters.ProtectedQuerySQLParameters"
    """<p>The protected SQL query parameters.</p>"""
    result_configuration: NotRequired[
        "capo_cleanrooms.types.protected_query_result_configuration.ProtectedQueryResultConfiguration"
    ]
    """<p>The details needed to write the query results.</p>"""
    compute_configuration: NotRequired[
        "capo_cleanrooms.types.compute_configuration.ComputeConfiguration"
    ]
    """<p> The compute configuration for the protected query.</p>"""
    query_compute_payer_account_id: NotRequired[
        "capo_cleanrooms.types.account_id.AccountId"
    ]
    """<p>The account ID of the member that pays for the query compute costs.</p>"""

compute_configuration instance-attribute

compute_configuration: NotRequired[ComputeConfiguration]

The compute configuration for the protected query.

membership_identifier instance-attribute

membership_identifier: MembershipIdentifier

A unique identifier for the membership to run this query against. Currently accepts a membership ID.

query_compute_payer_account_id instance-attribute

query_compute_payer_account_id: NotRequired[AccountId]

The account ID of the member that pays for the query compute costs.

result_configuration instance-attribute

result_configuration: NotRequired[ProtectedQueryResultConfiguration]

The details needed to write the query results.

sql_parameters instance-attribute

The protected SQL query parameters.

type instance-attribute

The type of the protected query to be started.