Skip to content
AWS for Query.Farm

aws.cleanrooms.get_collaboration

Example SQL Queries

SELECT * FROM
aws.cleanrooms.get_collaboration
WHERE
"collaboration_identifier" = 'VALUE';

Description

Returns metadata about a collaboration.

Table Definition

Column NameColumn Data Type
collaboration_identifier Required Input Column

The identifier for the collaboration.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
collaboration

The entire collaboration for this identifier.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "creator_account_id" VARCHAR,
    "creator_display_name" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "member_status" VARCHAR,
    "membership_id" VARCHAR,
    "membership_arn" VARCHAR,
    "data_encryption_metadata" STRUCT(
        "allow_cleartext" BOOLEAN,
        "allow_duplicates" BOOLEAN,
        "allow_joins_on_columns_with_different_names" BOOLEAN,
        "preserve_nulls" BOOLEAN
    ),
    "query_log_status" VARCHAR
)
Show child fields
collaboration.arn

The unique ARN for the collaboration.

collaboration.create_time

The time when the collaboration was created.

collaboration.creator_account_id

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

collaboration.creator_display_name

A display name of the collaboration creator.

collaboration.data_encryption_metadata

The settings for client-side encryption for cryptographic computing.

Show child fields
collaboration.data_encryption_metadata.allow_cleartext

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

collaboration.data_encryption_metadata.allow_duplicates

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

collaboration.data_encryption_metadata.allow_joins_on_columns_with_different_names

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

collaboration.data_encryption_metadata.preserve_nulls

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

collaboration.description

A description of the collaboration provided by the collaboration owner.

collaboration.id

The unique ID for the collaboration.

collaboration.member_status

The status of a member in a collaboration.

collaboration.membership_arn

The unique ARN for your membership within the collaboration.

collaboration.membership_id

The unique ID for your membership within the collaboration.

collaboration.name

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

collaboration.query_log_status

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

collaboration.update_time

The time the collaboration metadata was last updated.