Skip to content

CreateMembershipInput

Source code in docs_src/capo_cleanrooms/types/create_membership_input.py
class CreateMembershipInput(TypedDict, closed=True):
    collaboration_identifier: (
        "capo_cleanrooms.types.collaboration_identifier.CollaborationIdentifier"
    )
    """<p>The unique ID for the associated collaboration.</p>"""
    query_log_status: (
        "capo_cleanrooms.types.membership_query_log_status.MembershipQueryLogStatus"
    )
    """<p>An indicator as to whether query logging has been enabled or disabled for the membership.</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.membership_job_log_status.MembershipJobLogStatus"
    ]
    """<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>"""
    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>"""
    default_result_configuration: NotRequired[
        "capo_cleanrooms.types.membership_protected_query_result_configuration.MembershipProtectedQueryResultConfiguration"
    ]
    """<p>The default protected query result configuration as specified by the member who can receive results.</p>"""
    default_job_result_configuration: NotRequired[
        "capo_cleanrooms.types.membership_protected_job_result_configuration.MembershipProtectedJobResultConfiguration"
    ]
    """<p>The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.</p>"""
    payment_configuration: NotRequired[
        "capo_cleanrooms.types.membership_payment_configuration.MembershipPaymentConfiguration"
    ]
    """<p>The payment responsibilities accepted by the collaboration member.</p> <p>Not required if the collaboration member has the member ability to run queries. </p> <p>Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator. </p>"""
    is_metrics_enabled: NotRequired["bool"]
    """<p>An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.</p> <p>Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.</p> <p>When <code>true</code>, metrics about query execution are collected in Amazon CloudWatch. The default value is <code>false</code>.</p>"""

collaboration_identifier instance-attribute

collaboration_identifier: CollaborationIdentifier

The unique ID for the associated collaboration.

default_job_result_configuration instance-attribute

default_job_result_configuration: NotRequired[MembershipProtectedJobResultConfiguration]

The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.

default_result_configuration instance-attribute

default_result_configuration: NotRequired[MembershipProtectedQueryResultConfiguration]

The default protected query result configuration as specified by the member who can receive results.

is_metrics_enabled instance-attribute

is_metrics_enabled: NotRequired[bool]

An indicator as to whether Amazon CloudWatch metrics have been enabled or disabled for the membership.

Amazon CloudWatch metrics are only available when the collaboration has metrics enabled. This option can be set by collaboration members who have the ability to run queries (analysis runners) or by members who are configured as payers.

When true, metrics about query execution are collected in Amazon CloudWatch. The default value is false.

job_log_status instance-attribute

job_log_status: NotRequired[MembershipJobLogStatus]

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

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

payment_configuration instance-attribute

payment_configuration: NotRequired[MembershipPaymentConfiguration]

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

query_log_status instance-attribute

query_log_status: MembershipQueryLogStatus

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

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.