Skip to content

aws.cleanrooms.get_membership

Example SQL Queries

SELECT * FROM
aws.cleanrooms.get_membership
WHERE
"membership_identifier" = 'VALUE';

Description

Retrieves a specified membership for an identifier.

Table Definition

Column NameColumn Data Type
membership_identifier Required Input Column

The identifier for a membership resource.

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
membership

The membership retrieved for the provided identifier.

STRUCT(
"id" VARCHAR,
"arn" VARCHAR,
"collaboration_arn" VARCHAR,
"collaboration_id" VARCHAR,
"collaboration_creator_account_id" VARCHAR,
"collaboration_creator_display_name" VARCHAR,
"collaboration_name" VARCHAR,
"create_time" TIMESTAMP_S,
"update_time" TIMESTAMP_S,
"status" VARCHAR,
"member_abilities" VARCHAR[],
"query_log_status" VARCHAR,
"default_result_configuration" STRUCT(
"output_configuration" STRUCT(
"s3" STRUCT(
"result_format" VARCHAR,
"bucket" VARCHAR,
"key_prefix" VARCHAR
)
),
"role_arn" VARCHAR
),
"payment_configuration" STRUCT(
"query_compute" STRUCT(
"is_responsible" BOOLEAN
)
)
)
Show child fields
membership.arn

The unique ARN for the membership.

membership.collaboration_arn

The unique ARN for the membership's associated collaboration.

membership.collaboration_creator_account_id

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

membership.collaboration_creator_display_name

The display name of the collaboration creator.

membership.collaboration_id

The unique ID for the membership's collaboration.

membership.collaboration_name

The name of the membership's collaboration.

membership.create_time

The time when the membership was created.

membership.default_result_configuration

The default protected query result configuration as specified by the member who can receive results.

Show child fields
membership.default_result_configuration.output_configuration

Configuration for protected query results.

Show child fields
membership.default_result_configuration.output_configuration.s3

Contains the configuration to write the query results to S3.

Show child fields
membership.default_result_configuration.output_configuration.s3.bucket

The S3 bucket to unload the protected query results.

membership.default_result_configuration.output_configuration.s3.key_prefix

The S3 prefix to unload the protected query results.

membership.default_result_configuration.output_configuration.s3.result_format

Intended file format of the result.

membership.default_result_configuration.role_arn

The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.

membership.id

The unique ID of the membership.

membership.member_abilities[]
membership.payment_configuration

The payment responsibilities accepted by the collaboration member.

Show child fields
membership.payment_configuration.query_compute

The payment responsibilities accepted by the collaboration member for query compute costs.

Show child fields
membership.payment_configuration.query_compute.is_responsible

Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has not accepted to pay for query compute costs (FALSE).

If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer.

An error message is returned for the following reasons:

  • If you set the value to FALSE but you are responsible to pay for query compute costs.

  • If you set the value to TRUE but you are not responsible to pay for query compute costs.

membership.query_log_status

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

membership.status

The status of the membership.

membership.update_time

The time the membership metadata was last updated.