Skip to content

Membership

Source code in docs_src/capo_cleanrooms/types/membership.py
class Membership(TypedDict, closed=True):
    id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID of the membership.</p>"""
    arn: "capo_cleanrooms.types.membership_arn.MembershipArn"
    """<p>The unique ARN for the membership.</p>"""
    collaboration_arn: "capo_cleanrooms.types.collaboration_arn.CollaborationArn"
    """<p>The unique ARN for the membership's associated collaboration.</p>"""
    collaboration_id: "capo_cleanrooms.types.uuid.UUID"
    """<p>The unique ID for the membership's collaboration.</p>"""
    collaboration_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>"""
    collaboration_creator_display_name: "capo_cleanrooms.types.display_name.DisplayName"
    """<p>The display name of the collaboration creator.</p>"""
    collaboration_name: "capo_cleanrooms.types.collaboration_name.CollaborationName"
    """<p>The name of the membership's collaboration.</p>"""
    create_time: "datetime.datetime"
    """<p>The time when the membership was created.</p>"""
    update_time: "datetime.datetime"
    """<p>The time the membership metadata was last updated.</p>"""
    status: "capo_cleanrooms.types.membership_status.MembershipStatus"
    """<p>The status of the membership.</p>"""
    member_abilities: "capo_cleanrooms.types.member_abilities.MemberAbilities"
    """<p>The abilities granted to the collaboration member.</p>"""
    ml_member_abilities: NotRequired[
        "capo_cleanrooms.types.ml_member_abilities.MLMemberAbilities"
    ]
    """<p>Specifies the ML member abilities that are granted to a collaboration member.</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>"""
    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 for the membership.</p>"""
    payment_configuration: "capo_cleanrooms.types.membership_payment_configuration.MembershipPaymentConfiguration"
    """<p>The payment responsibilities accepted by the collaboration member.</p>"""
    is_metrics_enabled: NotRequired["bool"]
    """<p>An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.</p> <p>When <code>true</code>, metrics about query execution are collected in Amazon CloudWatch.</p>"""

arn instance-attribute

The unique ARN for the membership.

collaboration_arn instance-attribute

collaboration_arn: CollaborationArn

The unique ARN for the membership's associated collaboration.

collaboration_creator_account_id instance-attribute

collaboration_creator_account_id: AccountId

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

collaboration_creator_display_name instance-attribute

collaboration_creator_display_name: DisplayName

The display name of the collaboration creator.

collaboration_id instance-attribute

collaboration_id: UUID

The unique ID for the membership's collaboration.

collaboration_name instance-attribute

collaboration_name: CollaborationName

The name of the membership's collaboration.

create_time instance-attribute

create_time: datetime

The time when the membership was created.

default_job_result_configuration instance-attribute

default_job_result_configuration: NotRequired[MembershipProtectedJobResultConfiguration]

The default job result configuration for the membership.

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.

id instance-attribute

id: UUID

The unique ID of the membership.

is_metrics_enabled instance-attribute

is_metrics_enabled: NotRequired[bool]

An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.

When true, metrics about query execution are collected in Amazon CloudWatch.

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.

member_abilities instance-attribute

member_abilities: MemberAbilities

The abilities granted to the collaboration member.

ml_member_abilities instance-attribute

ml_member_abilities: NotRequired[MLMemberAbilities]

Specifies the ML member abilities that are granted to a collaboration member.

payment_configuration instance-attribute

payment_configuration: MembershipPaymentConfiguration

The payment responsibilities accepted by the collaboration member.

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.

status instance-attribute

The status of the membership.

update_time instance-attribute

update_time: datetime

The time the membership metadata was last updated.