CleanRoomsService / Client / create_collaboration

create_collaboration

CleanRoomsService.Client.create_collaboration(**kwargs)

Creates a new collaboration.

See also: AWS API Documentation

Request Syntax

response = client.create_collaboration(
    members=[
        {
            'accountId': 'string',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'displayName': 'string'
        },
    ],
    name='string',
    description='string',
    creatorMemberAbilities=[
        'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
    ],
    creatorDisplayName='string',
    dataEncryptionMetadata={
        'allowCleartext': True|False,
        'allowDuplicates': True|False,
        'allowJoinsOnColumnsWithDifferentNames': True|False,
        'preserveNulls': True|False
    },
    queryLogStatus='ENABLED'|'DISABLED',
    tags={
        'string': 'string'
    }
)

Parameters:

• members (list) –

  [REQUIRED]

  A list of initial members, not including the creator. This list is immutable.

  • (dict) –

    Basic metadata used to construct a new member.

    • accountId (string) – [REQUIRED]

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

    • memberAbilities (list) – [REQUIRED]

      The abilities granted to the collaboration member.

      • (string) –

    • displayName (string) – [REQUIRED]

      The member’s display name.

• name (string) –

  [REQUIRED]

  The display name for a collaboration.

• description (string) –

  [REQUIRED]

  A description of the collaboration provided by the collaboration owner.

• creatorMemberAbilities (list) –

  [REQUIRED]

  The abilities granted to the collaboration creator.

  • (string) –

• creatorDisplayName (string) –

  [REQUIRED]

  The display name of the collaboration creator.

• dataEncryptionMetadata (dict) –

  The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

  • allowCleartext (boolean) – [REQUIRED]

    Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

  • allowDuplicates (boolean) – [REQUIRED]

    Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

  • allowJoinsOnColumnsWithDifferentNames (boolean) – [REQUIRED]

    Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

  • preserveNulls (boolean) – [REQUIRED]

    Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

• queryLogStatus (string) –

  [REQUIRED]

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

• tags (dict) –

  An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'collaboration': {
        'id': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'creatorAccountId': 'string',
        'creatorDisplayName': 'string',
        'createTime': datetime(2015, 1, 1),
        'updateTime': datetime(2015, 1, 1),
        'memberStatus': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
        'membershipId': 'string',
        'membershipArn': 'string',
        'dataEncryptionMetadata': {
            'allowCleartext': True|False,
            'allowDuplicates': True|False,
            'allowJoinsOnColumnsWithDifferentNames': True|False,
            'preserveNulls': True|False
        },
        'queryLogStatus': 'ENABLED'|'DISABLED'
    }
}

Response Structure

• (dict) –

  • collaboration (dict) –

    The entire created collaboration object.

    • id (string) –

      The unique ID for the collaboration.

    • arn (string) –

      The unique ARN for the collaboration.

    • name (string) –

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

    • description (string) –

      A description of the collaboration provided by the collaboration owner.

    • creatorAccountId (string) –

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

    • creatorDisplayName (string) –

      A display name of the collaboration creator.

    • createTime (datetime) –

      The time when the collaboration was created.

    • updateTime (datetime) –

      The time the collaboration metadata was last updated.

    • memberStatus (string) –

      The status of a member in a collaboration.

    • membershipId (string) –

      The unique ID for your membership within the collaboration.

    • membershipArn (string) –

      The unique ARN for your membership within the collaboration.

    • dataEncryptionMetadata (dict) –

      The settings for client-side encryption for cryptographic computing.

      • allowCleartext (boolean) –

        Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

      • allowDuplicates (boolean) –

        Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

      • allowJoinsOnColumnsWithDifferentNames (boolean) –

        Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

      • preserveNulls (boolean) –

        Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

    • queryLogStatus (string) –

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

Exceptions

• CleanRoomsService.Client.exceptions.ServiceQuotaExceededException

• CleanRoomsService.Client.exceptions.InternalServerException

• CleanRoomsService.Client.exceptions.ValidationException

• CleanRoomsService.Client.exceptions.ThrottlingException

• CleanRoomsService.Client.exceptions.AccessDeniedException