AWS Clean Rooms Service

{'analyticsEngine': 'SPARK | CLEAN_ROOMS_SQL'}

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

See also: AWS API Documentation

Request Syntax

client.update_collaboration(
    collaborationIdentifier='string',
    name='string',
    description='string',
    analyticsEngine='SPARK'|'CLEAN_ROOMS_SQL'
)

type collaborationIdentifier:

string

param collaborationIdentifier:

[REQUIRED]

The identifier for the collaboration.

type name:

string

param name:

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

type description:

string

param description:

A description of the collaboration.

type analyticsEngine:

string

param analyticsEngine:

The analytics engine.

rtype:

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',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL'
    }
}

Response Structure

• (dict) --

  • collaboration (dict) --

    The entire collaboration that has been updated.

    • 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.

      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.

    • jobLogStatus (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.

    • analyticsEngine (string) --

      The analytics engine for the collaboration.