Collaboration - AWS Clean Rooms

Collaboration

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

Contents

arn

The unique ARN for the 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

createTime

The time when the collaboration was created.

Type: Timestamp

Required: Yes

creatorAccountId

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

creatorDisplayName

A 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

id

The unique ID for the 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

memberStatus

The status of a member in a collaboration.

Type: String

Valid Values: INVITED | ACTIVE | LEFT | REMOVED

Required: Yes

name

A human-readable identifier provided by the collaboration owner. Display names are not unique.

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

queryLogStatus

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

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

updateTime

The time the collaboration metadata was last updated.

Type: Timestamp

Required: Yes

analyticsEngine

The analytics engine for the collaboration.

Type: String

Valid Values: SPARK | CLEAN_ROOMS_SQL

Required: No

dataEncryptionMetadata

The settings for client-side encryption for cryptographic computing.

Type: DataEncryptionMetadata object

Required: No

description

A description of the collaboration provided by the collaboration owner.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*

Required: No

membershipArn

The unique ARN for your membership within the 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}:membership/[\d\w-]+

Required: No

membershipId

The unique ID for your membership within the 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: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: