Collaboration ¶

class Collaboration(TypedDict, closed=True):
    id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID for the collaboration.</p>"""
    arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The unique ARN for the collaboration.</p>"""
    name: "capo_cleanrooms.types.collaboration_name.CollaborationName"
    """<p>A human-readable identifier provided by the collaboration owner. Display names are not unique.</p>"""
    description: NotRequired[
        "capo_cleanrooms.types.collaboration_description.CollaborationDescription"
    ]
    """<p>A description of the collaboration provided by the collaboration owner.</p>"""
    creator_account_id: "capo_cleanrooms.types.account_id.AccountId"
    """<p>The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.</p>"""
    creator_display_name: "capo_cleanrooms.types.display_name.DisplayName"
    """<p>A display name of the collaboration creator.</p>"""
    create_time: "datetime.datetime"
    """<p>The time when the collaboration was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The time the collaboration metadata was last updated.</p>"""
    member_status: "capo_cleanrooms.types.member_status.MemberStatus"
    """<p>The status of a member in a collaboration.</p>"""
    membership_id: NotRequired["capo_cleanrooms.types.uuid.UUID"]
    """<p>The unique ID for your membership within the collaboration.</p>"""
    membership_arn: NotRequired["capo_cleanrooms.types.membership_arn.MembershipArn"]
    """<p>The unique ARN for your membership within the collaboration.</p>"""
    data_encryption_metadata: NotRequired[
        "capo_cleanrooms.types.data_encryption_metadata.DataEncryptionMetadata"
    ]
    """<p>The settings for client-side encryption for cryptographic computing.</p>"""
    query_log_status: "capo_cleanrooms.types.collaboration_query_log_status.CollaborationQueryLogStatus"
    """<p>An indicator as to whether query logging has been enabled or disabled for the collaboration.</p> <p>When <code>ENABLED</code>, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>"""
    job_log_status: NotRequired[
        "capo_cleanrooms.types.collaboration_job_log_status.CollaborationJobLogStatus"
    ]
    """<p>An indicator as to whether job logging has been enabled or disabled for the collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>"""
    analytics_engine: NotRequired[
        "capo_cleanrooms.types.analytics_engine.AnalyticsEngine"
    ]
    """<p> The analytics engine for the collaboration.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"""
    auto_approved_change_types: NotRequired[
        "capo_cleanrooms.types.auto_approved_change_type_list.AutoApprovedChangeTypeList"
    ]
    """<p>The types of change requests that are automatically approved for this collaboration.</p>"""
    allowed_result_regions: NotRequired[
        "capo_cleanrooms.types.allowed_result_regions.AllowedResultRegions"
    ]
    """<p>The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.</p>"""
    is_metrics_enabled: NotRequired["bool"]
    """<p>An indicator as to whether metrics are enabled for the collaboration.</p> <p>When <code>true</code>, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.</p>"""