CleanRoomsService / Client / get_collaboration

get_collaboration

CleanRoomsService.Client.get_collaboration(**kwargs)

Returns metadata about a collaboration.

See also: AWS API Documentation

Request Syntax

response = client.get_collaboration(
    collaborationIdentifier='string'
)
Parameters:

collaborationIdentifier (string) –

[REQUIRED]

The identifier for the collaboration.

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',
        'jobLogStatus': 'ENABLED'|'DISABLED',
        'analyticsEngine': 'SPARK'|'CLEAN_ROOMS_SQL',
        'autoApprovedChangeTypes': [
            'ADD_MEMBER',
        ],
        'allowedResultRegions': [
            'us-west-1'|'us-west-2'|'us-east-1'|'us-east-2'|'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-5'|'ap-southeast-4'|'ap-southeast-7'|'ap-south-1'|'ap-northeast-3'|'ap-northeast-1'|'ap-northeast-2'|'ca-central-1'|'ca-west-1'|'eu-south-1'|'eu-west-3'|'eu-south-2'|'eu-central-2'|'eu-central-1'|'eu-north-1'|'eu-west-1'|'eu-west-2'|'me-south-1'|'me-central-1'|'il-central-1'|'sa-east-1'|'mx-central-1',
        ]
    }
}

Response Structure

  • (dict) –

    • collaboration (dict) –

      The entire collaboration for this identifier.

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

        Note

        After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

      • autoApprovedChangeTypes (list) –

        The types of change requests that are automatically approved for this collaboration.

        • (string) –

      • allowedResultRegions (list) –

        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.

        • (string) –

Exceptions