collaborations

Creates, updates, deletes or gets a collaboration resource or lists collaborations in a region

Overview

Name	collaborations
Type	Resource
Description	Represents a collaboration between AWS accounts that allows for secure data collaboration
Id	awscc.cleanrooms.collaborations

Fields

get (all properties)

Name	Datatype	Description
arn	string
▶tags	array	An arbitrary set of tags (key-value pairs) for this cleanrooms collaboration.
collaboration_identifier	string
creator_display_name	string
creator_member_abilities	array
▶creator_ml_member_abilities	object
▶data_encryption_metadata	object
description	string
▶members	array
name	string
job_log_status	string
query_log_status	string
analytics_engine	string
▶creator_payment_configuration	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
collaboration_identifier	string
region	string	AWS region.

For more information, see AWS::CleanRooms::Collaboration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	collaborations	INSERT	CreatorDisplayName, Name, Description, QueryLogStatus, region
delete_resource	collaborations	DELETE	Identifier, region
update_resource	collaborations	UPDATE	Identifier, PatchDocument, region
list_resources	collaborations_list_only	SELECT	region
get_resource	collaborations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual collaboration.

SELECT
  region,
  arn,
  tags,
  collaboration_identifier,
  creator_display_name,
  creator_member_abilities,
  creator_ml_member_abilities,
  data_encryption_metadata,
  description,
  members,
  name,
  job_log_status,
  query_log_status,
  analytics_engine,
  creator_payment_configuration
FROM awscc.cleanrooms.collaborations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ collaboration_identifier }}';

list (identifiers only)

Lists all collaborations in a region.

SELECT
  region,
  collaboration_identifier
FROM awscc.cleanrooms.collaborations_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new collaboration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cleanrooms.collaborations (
  CreatorDisplayName,
  Description,
  Name,
  QueryLogStatus,
  region
)
SELECT
  '{{ creator_display_name }}',
  '{{ description }}',
  '{{ name }}',
  '{{ query_log_status }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.cleanrooms.collaborations (
  Tags,
  CreatorDisplayName,
  CreatorMemberAbilities,
  CreatorMLMemberAbilities,
  DataEncryptionMetadata,
  Description,
  Members,
  Name,
  JobLogStatus,
  QueryLogStatus,
  AnalyticsEngine,
  CreatorPaymentConfiguration,
  region
)
SELECT
  '{{ tags }}',
  '{{ creator_display_name }}',
  '{{ creator_member_abilities }}',
  '{{ creator_ml_member_abilities }}',
  '{{ data_encryption_metadata }}',
  '{{ description }}',
  '{{ members }}',
  '{{ name }}',
  '{{ job_log_status }}',
  '{{ query_log_status }}',
  '{{ analytics_engine }}',
  '{{ creator_payment_configuration }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: collaboration
    props:
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: creator_display_name
        value: '{{ creator_display_name }}'
      - name: creator_member_abilities
        value:
          - '{{ creator_member_abilities[0] }}'
      - name: creator_ml_member_abilities
        value:
          custom_ml_member_abilities:
            - '{{ custom_ml_member_abilities[0] }}'
      - name: data_encryption_metadata
        value:
          allow_cleartext: '{{ allow_cleartext }}'
          allow_duplicates: '{{ allow_duplicates }}'
          allow_joins_on_columns_with_different_names: '{{ allow_joins_on_columns_with_different_names }}'
          preserve_nulls: '{{ preserve_nulls }}'
      - name: description
        value: '{{ description }}'
      - name: members
        value:
          - account_id: '{{ account_id }}'
            member_abilities: null
            ml_member_abilities: null
            display_name: null
            payment_configuration:
              job_compute:
                is_responsible: '{{ is_responsible }}'
              query_compute:
                is_responsible: '{{ is_responsible }}'
              machine_learning:
                model_training:
                  is_responsible: '{{ is_responsible }}'
                model_inference:
                  is_responsible: '{{ is_responsible }}'
      - name: name
        value: '{{ name }}'
      - name: job_log_status
        value: '{{ job_log_status }}'
      - name: query_log_status
        value: '{{ query_log_status }}'
      - name: analytics_engine
        value: '{{ analytics_engine }}'
      - name: creator_payment_configuration
        value: null

UPDATE example

Use the following StackQL query and manifest file to update a collaboration resource, using stack-deploy.

/*+ update */
UPDATE awscc.cleanrooms.collaborations
SET PatchDocument = string('{{ {
    "Tags": tags,
    "Description": description,
    "Name": name,
    "AnalyticsEngine": analytics_engine
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ collaboration_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.cleanrooms.collaborations
WHERE
  Identifier = '{{ collaboration_identifier }}' AND
  region = 'us-east-1';

Permissions

To operate on the collaborations resource, the following permissions are required:

Create

cleanrooms:CreateCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:GetCollaboration,
cleanrooms:ListCollaborations

Read

cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource

Update

cleanrooms:UpdateCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListMembers,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource

Delete

cleanrooms:DeleteCollaboration,
cleanrooms:GetCollaboration,
cleanrooms:ListTagsForResource,
cleanrooms:UntagResource,
cleanrooms:ListMembers,
cleanrooms:ListCollaborations

List

cleanrooms:ListCollaborations