collaborations

Creates, updates, deletes, gets or lists a collaborations resource.

Overview

Name	collaborations
Type	Resource
Id	aws.cleanrooms.collaborations

Fields

The following fields are returned by SELECT queries:

get_collaboration

Name	Datatype	Description
id	string	The unique ID for the collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	A human-readable identifier provided by the collaboration owner. Display names are not unique. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
allowed_result_regions	array	The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.
analytics_engine	string	The analytics engine for the collaboration. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available. (SPARK, CLEAN_ROOMS_SQL)
arn	string	The unique ARN for the collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
auto_approved_change_types	array	The types of change requests that are automatically approved for this collaboration.
create_time	string (date-time)	The time when the collaboration was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
creator_display_name	string	A display name of the collaboration creator. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
data_encryption_metadata	object	The settings for client-side encryption for cryptographic computing.
description	string	A description of the collaboration provided by the collaboration owner. (pattern: <code>(?!\s+$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t\r\n]*</code>)
is_metrics_enabled	boolean	An indicator as to whether metrics are enabled for the collaboration. When true, collaboration members can opt in to Amazon CloudWatch metrics for their membership queries.
job_log_status	string	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. (ENABLED, DISABLED)
member_status	string	The status of a member in a collaboration. (INVITED, ACTIVE, LEFT, REMOVED)
membership_arn	string	The unique ARN for your membership within the collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique ID for your membership within the collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
query_log_status	string	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. (ENABLED, DISABLED)
update_time	string (date-time)	The time the collaboration metadata was last updated.

list_collaborations

Name	Datatype	Description
id	string	The identifier for the collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
name	string	A human-readable identifier provided by the collaboration owner. Display names are not unique. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
analytics_engine	string	The analytics engine. After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available. (SPARK, CLEAN_ROOMS_SQL)
arn	string	The ARN of the collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:collaboration/[\d\w-]+</code>)
create_time	string (date-time)	The time when the collaboration was created.
creator_account_id	string	The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
creator_display_name	string	The display name of the collaboration creator. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
member_status	string	The status of a member in a collaboration. (INVITED, ACTIVE, LEFT, REMOVED)
membership_arn	string	The ARN of a member in a collaboration. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The identifier of a member in a collaboration. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
update_time	string (date-time)	The time the collaboration metadata was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_collaboration	select	collaboration_identifier, region		Returns metadata about a collaboration.
list_collaborations	select	region	nextToken, maxResults, memberStatus	Lists collaborations the caller owns, is active in, or has been invited to.
create_collaboration	insert	region, members, name, creatorMemberAbilities, creatorDisplayName, queryLogStatus		Creates a new collaboration.
update_collaboration	update	collaboration_identifier, region		Updates collaboration metadata and can only be called by the collaboration owner.
delete_collaboration	delete	collaboration_identifier, region		Deletes a collaboration. It can only be called by the collaboration owner.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collaboration_identifier	string	The identifier for the collaboration.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
memberStatus	string	The caller's status in a collaboration.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

get_collaboration

Returns metadata about a collaboration.

SELECT
id,
name,
allowed_result_regions,
analytics_engine,
arn,
auto_approved_change_types,
create_time,
creator_account_id,
creator_display_name,
data_encryption_metadata,
description,
is_metrics_enabled,
job_log_status,
member_status,
membership_arn,
membership_id,
query_log_status,
update_time
FROM aws.cleanrooms.collaborations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_collaborations

Lists collaborations the caller owns, is active in, or has been invited to.

SELECT
id,
name,
analytics_engine,
arn,
create_time,
creator_account_id,
creator_display_name,
member_status,
membership_arn,
membership_id,
update_time
FROM aws.cleanrooms.collaborations
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND memberStatus = '{{ memberStatus }}'
;

INSERT examples

create_collaboration

Creates a new collaboration.

INSERT INTO aws.cleanrooms.collaborations (
members,
name,
description,
creatorMemberAbilities,
creatorMLMemberAbilities,
creatorDisplayName,
dataEncryptionMetadata,
queryLogStatus,
jobLogStatus,
tags,
creatorPaymentConfiguration,
analyticsEngine,
autoApprovedChangeRequestTypes,
allowedResultRegions,
isMetricsEnabled,
region
)
SELECT 
'{{ members }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ creatorMemberAbilities }}' /* required */,
'{{ creatorMLMemberAbilities }}',
'{{ creatorDisplayName }}' /* required */,
'{{ dataEncryptionMetadata }}',
'{{ queryLogStatus }}' /* required */,
'{{ jobLogStatus }}',
'{{ tags }}',
'{{ creatorPaymentConfiguration }}',
'{{ analyticsEngine }}',
'{{ autoApprovedChangeRequestTypes }}',
'{{ allowedResultRegions }}',
{{ isMetricsEnabled }},
'{{ region }}'
RETURNING
collaboration
;

Manifest

# Description fields are for documentation purposes
- name: collaborations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the collaborations resource.
  - name: members
    value:
      - accountId: "{{ accountId }}"
        memberAbilities: "{{ memberAbilities }}"
        mlMemberAbilities:
          customMLMemberAbilities:
            - "{{ customMLMemberAbilities }}"
        displayName: "{{ displayName }}"
        paymentConfiguration:
          queryCompute:
            isResponsible: {{ isResponsible }}
          machineLearning:
            modelTraining:
              isResponsible: {{ isResponsible }}
            modelInference:
              isResponsible: {{ isResponsible }}
            syntheticDataGeneration:
              isResponsible: {{ isResponsible }}
          jobCompute:
            isResponsible: {{ isResponsible }}
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: creatorMemberAbilities
    value:
      - "{{ creatorMemberAbilities }}"
  - name: creatorMLMemberAbilities
    description: |
      The ML member abilities for a collaboration member.
    value:
      customMLMemberAbilities:
        - "{{ customMLMemberAbilities }}"
  - name: creatorDisplayName
    value: "{{ creatorDisplayName }}"
  - name: dataEncryptionMetadata
    description: |
      The settings for client-side encryption for cryptographic computing.
    value:
      allowCleartext: {{ allowCleartext }}
      allowDuplicates: {{ allowDuplicates }}
      allowJoinsOnColumnsWithDifferentNames: {{ allowJoinsOnColumnsWithDifferentNames }}
      preserveNulls: {{ preserveNulls }}
  - name: queryLogStatus
    value: "{{ queryLogStatus }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: jobLogStatus
    value: "{{ jobLogStatus }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags assigned to a resource
  - name: creatorPaymentConfiguration
    description: |
      An object representing the collaboration member's payment responsibilities set by the collaboration creator.
    value:
      queryCompute:
        isResponsible: {{ isResponsible }}
      machineLearning:
        modelTraining:
          isResponsible: {{ isResponsible }}
        modelInference:
          isResponsible: {{ isResponsible }}
        syntheticDataGeneration:
          isResponsible: {{ isResponsible }}
      jobCompute:
        isResponsible: {{ isResponsible }}
  - name: analyticsEngine
    value: "{{ analyticsEngine }}"
    valid_values: ['SPARK', 'CLEAN_ROOMS_SQL']
  - name: autoApprovedChangeRequestTypes
    value:
      - "{{ autoApprovedChangeRequestTypes }}"
  - name: allowedResultRegions
    value:
      - "{{ allowedResultRegions }}"
  - name: isMetricsEnabled
    value: {{ isMetricsEnabled }}

UPDATE examples

update_collaboration

Updates collaboration metadata and can only be called by the collaboration owner.

UPDATE aws.cleanrooms.collaborations
SET 
name = '{{ name }}',
description = '{{ description }}',
analyticsEngine = '{{ analyticsEngine }}'
WHERE 
collaboration_identifier = '{{ collaboration_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
collaboration;

DELETE examples

delete_collaboration

Deletes a collaboration. It can only be called by the collaboration owner.

DELETE FROM aws.cleanrooms.collaborations
WHERE collaboration_identifier = '{{ collaboration_identifier }}' --required
AND region = '{{ region }}' --required
;