Skip to content

ProtectedQuery

Source code in docs_src/capo_cleanrooms/types/protected_query.py
class ProtectedQuery(TypedDict, closed=True):
    id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The identifier for a protected query instance.</p>"""
    membership_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The identifier for the membership.</p>"""
    membership_arn: "capo_cleanrooms.types.membership_arn.MembershipArn"
    """<p>The ARN of the membership.</p>"""
    create_time: "datetime.datetime"
    """<p>The time at which the protected query was created.</p>"""
    sql_parameters: NotRequired[
        "capo_cleanrooms.types.protected_query_sql_parameters.ProtectedQuerySQLParameters"
    ]
    """<p>The protected query SQL parameters.</p>"""
    status: "capo_cleanrooms.types.protected_query_status.ProtectedQueryStatus"
    """<p>The status of the query.</p>"""
    result_configuration: NotRequired[
        "capo_cleanrooms.types.protected_query_result_configuration.ProtectedQueryResultConfiguration"
    ]
    """<p>Contains any details needed to write the query results.</p>"""
    statistics: NotRequired[
        "capo_cleanrooms.types.protected_query_statistics.ProtectedQueryStatistics"
    ]
    """<p>Statistics about protected query execution.</p>"""
    result: NotRequired[
        "capo_cleanrooms.types.protected_query_result.ProtectedQueryResult"
    ]
    """<p>The result of the protected query.</p>"""
    error: NotRequired[
        "capo_cleanrooms.types.protected_query_error.ProtectedQueryError"
    ]
    """<p>An error thrown by the protected query.</p>"""
    differential_privacy: NotRequired[
        "capo_cleanrooms.types.differential_privacy_parameters.DifferentialPrivacyParameters"
    ]
    """<p>The sensitivity parameters of the differential privacy results of the protected query.</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.

create_time instance-attribute

create_time: datetime

The time at which the protected query was created.

differential_privacy instance-attribute

differential_privacy: NotRequired[DifferentialPrivacyParameters]

The sensitivity parameters of the differential privacy results of the protected query.

error instance-attribute

error: NotRequired[ProtectedQueryError]

An error thrown by the protected query.

id instance-attribute

id: UUID

The identifier for a protected query instance.

membership_arn instance-attribute

membership_arn: MembershipArn

The ARN of the membership.

membership_id instance-attribute

membership_id: UUID

The identifier for the membership.

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 instance-attribute

result: NotRequired[ProtectedQueryResult]

The result of the protected query.

result_configuration instance-attribute

result_configuration: NotRequired[ProtectedQueryResultConfiguration]

Contains any details needed to write the query results.

sql_parameters instance-attribute

sql_parameters: NotRequired[ProtectedQuerySQLParameters]

The protected query SQL parameters.

statistics instance-attribute

statistics: NotRequired[ProtectedQueryStatistics]

Statistics about protected query execution.

status instance-attribute

The status of the query.