# Membership
<a name="API_Membership"></a>

The membership object.

## Contents
<a name="API_Membership_Contents"></a>

 ** arn **   <a name="API-Type-Membership-arn"></a>
The unique ARN for the membership.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+`   
Required: Yes

 ** collaborationArn **   <a name="API-Type-Membership-collaborationArn"></a>
The unique ARN for the membership's associated collaboration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Pattern: `arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+`   
Required: Yes

 ** collaborationCreatorAccountId **   <a name="API-Type-Membership-collaborationCreatorAccountId"></a>
The identifier used to reference members of the collaboration. Currently only supports AWS account ID.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d+`   
Required: Yes

 ** collaborationCreatorDisplayName **   <a name="API-Type-Membership-collaborationCreatorDisplayName"></a>
The display name of the collaboration creator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** collaborationId **   <a name="API-Type-Membership-collaborationId"></a>
The unique ID for the membership's collaboration.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** collaborationName **   <a name="API-Type-Membership-collaborationName"></a>
The name of the membership's collaboration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*`   
Required: Yes

 ** createTime **   <a name="API-Type-Membership-createTime"></a>
The time when the membership was created.  
Type: Timestamp  
Required: Yes

 ** id **   <a name="API-Type-Membership-id"></a>
The unique ID of the membership.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`   
Required: Yes

 ** memberAbilities **   <a name="API-Type-Membership-memberAbilities"></a>
The abilities granted to the collaboration member.  
Type: Array of strings  
Valid Values: `CAN_QUERY | CAN_RECEIVE_RESULTS | CAN_RUN_JOB`   
Required: Yes

 ** paymentConfiguration **   <a name="API-Type-Membership-paymentConfiguration"></a>
The payment responsibilities accepted by the collaboration member.  
Type: [MembershipPaymentConfiguration](API_MembershipPaymentConfiguration.md) object  
Required: Yes

 ** queryLogStatus **   <a name="API-Type-Membership-queryLogStatus"></a>
An indicator as to whether query logging has been enabled or disabled for the membership.  
When `ENABLED`, AWS 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`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** status **   <a name="API-Type-Membership-status"></a>
The status of the membership.  
Type: String  
Valid Values: `ACTIVE | REMOVED | COLLABORATION_DELETED`   
Required: Yes

 ** updateTime **   <a name="API-Type-Membership-updateTime"></a>
The time the membership metadata was last updated.  
Type: Timestamp  
Required: Yes

 ** defaultJobResultConfiguration **   <a name="API-Type-Membership-defaultJobResultConfiguration"></a>
 The default job result configuration for the membership.  
Type: [MembershipProtectedJobResultConfiguration](API_MembershipProtectedJobResultConfiguration.md) object  
Required: No

 ** defaultResultConfiguration **   <a name="API-Type-Membership-defaultResultConfiguration"></a>
The default protected query result configuration as specified by the member who can receive results.  
Type: [MembershipProtectedQueryResultConfiguration](API_MembershipProtectedQueryResultConfiguration.md) object  
Required: No

 ** isMetricsEnabled **   <a name="API-Type-Membership-isMetricsEnabled"></a>
An indicator as to whether Amazon CloudWatch metrics are enabled for the membership.  
When `true`, metrics about query execution are collected in Amazon CloudWatch.  
Type: Boolean  
Required: No

 ** jobLogStatus **   <a name="API-Type-Membership-jobLogStatus"></a>
An indicator as to whether job logging has been enabled or disabled for the collaboration.   
When `ENABLED`, AWS 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`.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** mlMemberAbilities **   <a name="API-Type-Membership-mlMemberAbilities"></a>
Specifies the ML member abilities that are granted to a collaboration member.  
Type: [MLMemberAbilities](API_MLMemberAbilities.md) object  
Required: No

## See Also
<a name="API_Membership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/cleanrooms-2022-02-17/Membership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/cleanrooms-2022-02-17/Membership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/cleanrooms-2022-02-17/Membership)