Skip to content

CreateCollaborationInput

Source code in docs_src/capo_cleanrooms/types/create_collaboration_input.py
class CreateCollaborationInput(TypedDict, closed=True):
    members: "capo_cleanrooms.types.member_list.MemberList"
    """<p>A list of initial members, not including the creator. This list is immutable.</p>"""
    name: "capo_cleanrooms.types.collaboration_name.CollaborationName"
    """<p>The display name for a collaboration.</p>"""
    description: (
        "capo_cleanrooms.types.collaboration_description.CollaborationDescription"
    )
    """<p>A description of the collaboration provided by the collaboration owner.</p>"""
    creator_member_abilities: "capo_cleanrooms.types.member_abilities.MemberAbilities"
    """<p>The abilities granted to the collaboration creator.</p>"""
    creator_ml_member_abilities: NotRequired[
        "capo_cleanrooms.types.ml_member_abilities.MLMemberAbilities"
    ]
    """<p>The ML abilities granted to the collaboration creator.</p>"""
    creator_display_name: "capo_cleanrooms.types.display_name.DisplayName"
    """<p>The display name of the collaboration creator.</p>"""
    data_encryption_metadata: NotRequired[
        "capo_cleanrooms.types.data_encryption_metadata.DataEncryptionMetadata"
    ]
    """<p>The settings for client-side encryption with Cryptographic Computing for Clean Rooms.</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>Specifies whether job logs are enabled for this collaboration. </p> <p>When <code>ENABLED</code>, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is <code>DISABLED</code>.</p>"""
    tags: NotRequired["capo_cleanrooms.types.tag_map.TagMap"]
    """<p>An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.</p>"""
    creator_payment_configuration: NotRequired[
        "capo_cleanrooms.types.payment_configuration.PaymentConfiguration"
    ]
    """<p>The collaboration creator's payment responsibilities set by the collaboration creator. </p> <p>If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.</p>"""
    analytics_engine: NotRequired[
        "capo_cleanrooms.types.analytics_engine.AnalyticsEngine"
    ]
    """<p> The analytics engine.</p> <note> <p>After July 16, 2025, the <code>CLEAN_ROOMS_SQL</code> parameter will no longer be available. </p> </note>"""
    auto_approved_change_request_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. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.</p>"""
    is_metrics_enabled: NotRequired["bool"]
    """<p>An indicator as to whether metrics have been enabled or disabled for the collaboration.</p> <p>When <code>true</code>, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value is <code>false</code>.</p>"""

allowed_result_regions instance-attribute

allowed_result_regions: NotRequired[AllowedResultRegions]

The Amazon Web Services Regions where collaboration query results can be stored. When specified, results can only be written to these Regions. This parameter enables you to meet your compliance and data governance requirements, and implement regional data governance policies.

analytics_engine instance-attribute

analytics_engine: NotRequired[AnalyticsEngine]

The analytics engine.

After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

auto_approved_change_request_types instance-attribute

auto_approved_change_request_types: NotRequired[AutoApprovedChangeTypeList]

The types of change requests that are automatically approved for this collaboration.

creator_display_name instance-attribute

creator_display_name: DisplayName

The display name of the collaboration creator.

creator_member_abilities instance-attribute

creator_member_abilities: MemberAbilities

The abilities granted to the collaboration creator.

creator_ml_member_abilities instance-attribute

creator_ml_member_abilities: NotRequired[MLMemberAbilities]

The ML abilities granted to the collaboration creator.

creator_payment_configuration instance-attribute

creator_payment_configuration: NotRequired[PaymentConfiguration]

The collaboration creator's payment responsibilities set by the collaboration creator.

If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

data_encryption_metadata instance-attribute

data_encryption_metadata: NotRequired[DataEncryptionMetadata]

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

description instance-attribute

A description of the collaboration provided by the collaboration owner.

is_metrics_enabled instance-attribute

is_metrics_enabled: NotRequired[bool]

An indicator as to whether metrics have been enabled or disabled for the collaboration.

When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries. The default value is false.

job_log_status instance-attribute

job_log_status: NotRequired[CollaborationJobLogStatus]

Specifies whether job logs are enabled for this collaboration.

When ENABLED, Clean Rooms logs details about jobs run within this collaboration; those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

members instance-attribute

members: MemberList

A list of initial members, not including the creator. This list is immutable.

name instance-attribute

The display name for a collaboration.

query_log_status instance-attribute

query_log_status: CollaborationQueryLogStatus

An indicator as to whether query logging has been enabled or disabled for the collaboration.

When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

tags instance-attribute

tags: NotRequired[TagMap]

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.