Skip to content
AWS for Query.Farm

aws.cleanrooms.get_collaboration_analysis_template

Example SQL Queries

SELECT * FROM
aws.cleanrooms.get_collaboration_analysis_template
WHERE
"collaboration_identifier" = 'VALUE'
AND "analysis_template_arn" = 'VALUE';

Description

Retrieves an analysis template within a collaboration.

Table Definition

Column NameColumn Data Type
analysis_template_arn Required Input Column

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

VARCHAR
collaboration_identifier Required Input Column

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

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_analysis_template

The analysis template within a collaboration.

STRUCT(
    "id" VARCHAR,
    "arn" VARCHAR,
    "collaboration_id" VARCHAR,
    "collaboration_arn" VARCHAR,
    "description" VARCHAR,
    "creator_account_id" VARCHAR,
    "name" VARCHAR,
    "create_time" TIMESTAMP_S,
    "update_time" TIMESTAMP_S,
    "schema" STRUCT(
        "referenced_tables" VARCHAR[]
    ),
    "format" VARCHAR,
    "source" STRUCT(
        "text" VARCHAR
    ),
    "analysis_parameters" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "default_value" VARCHAR
    )[],
    "validations" STRUCT(
        "type" VARCHAR,
        "status" VARCHAR,
        "reasons" STRUCT(
            "message" VARCHAR
        )[]
    )[]
)
Show child fields
collaboration_analysis_template.analysis_parameters[]
Show child fields
collaboration_analysis_template.analysis_parameters[].default_value

Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

collaboration_analysis_template.analysis_parameters[].name

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

collaboration_analysis_template.analysis_parameters[].type

The type of parameter.

collaboration_analysis_template.arn

The Amazon Resource Name (ARN) of the analysis template.

collaboration_analysis_template.collaboration_arn

The unique ARN for the analysis template’s associated collaboration.

collaboration_analysis_template.collaboration_id

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

collaboration_analysis_template.create_time

The time that the analysis template within a collaboration was created.

collaboration_analysis_template.creator_account_id

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

collaboration_analysis_template.description

The description of the analysis template.

collaboration_analysis_template.format

The format of the analysis template in the collaboration.

collaboration_analysis_template.id

The identifier of the analysis template.

collaboration_analysis_template.name

The name of the analysis template.

collaboration_analysis_template.schema

The entire schema object.

Show child fields
collaboration_analysis_template.schema.referenced_tables[]
collaboration_analysis_template.source

The source of the analysis template within a collaboration.

Show child fields
collaboration_analysis_template.source.text

The query text.

collaboration_analysis_template.update_time

The time that the analysis template in the collaboration was last updated.

collaboration_analysis_template.validations[]
Show child fields
collaboration_analysis_template.validations[].reasons[]
Show child fields
collaboration_analysis_template.validations[].reasons[].message

The validation message.

collaboration_analysis_template.validations[].status

The status of the validation.

collaboration_analysis_template.validations[].type

The type of validation that was performed.