Skip to main content

memberships

Creates, updates, deletes or gets a membership resource or lists memberships in a region

Overview

Namememberships
TypeResource
DescriptionRepresents an AWS account that is a part of a collaboration
Idaws.cleanrooms.memberships

Fields

NameDatatypeDescription
arnstring
tagsarrayAn arbitrary set of tags (key-value pairs) for this cleanrooms membership.
collaboration_arnstring
collaboration_creator_account_idstring
collaboration_identifierstring
membership_identifierstring
query_log_statusstring
default_result_configurationobject
payment_configurationobject
regionstringAWS region.

Methods

NameAccessible byRequired Params
create_resourceINSERTCollaborationIdentifier, QueryLogStatus, region
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples

Gets all memberships in a region.

SELECT
region,
arn,
tags,
collaboration_arn,
collaboration_creator_account_id,
collaboration_identifier,
membership_identifier,
query_log_status,
default_result_configuration,
payment_configuration
FROM aws.cleanrooms.memberships
WHERE region = 'us-east-1';

Gets all properties from an individual membership.

SELECT
region,
arn,
tags,
collaboration_arn,
collaboration_creator_account_id,
collaboration_identifier,
membership_identifier,
query_log_status,
default_result_configuration,
payment_configuration
FROM aws.cleanrooms.memberships
WHERE region = 'us-east-1' AND data__Identifier = '<MembershipIdentifier>';

INSERT example

Use the following StackQL query and manifest file to create a new membership resource, using stack-deploy.

/*+ create */
INSERT INTO aws.cleanrooms.memberships (
CollaborationIdentifier,
QueryLogStatus,
region
)
SELECT
'{{ CollaborationIdentifier }}',
'{{ QueryLogStatus }}',
'{{ region }}';

DELETE example

/*+ delete */
DELETE FROM aws.cleanrooms.memberships
WHERE data__Identifier = '<MembershipIdentifier>'
AND region = 'us-east-1';

Permissions

To operate on the memberships resource, the following permissions are required:

Create

cleanrooms:CreateMembership,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:PutResourcePolicy,
logs:CreateLogGroup,
cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:ListMemberships,
iam:PassRole

Read

cleanrooms:GetMembership,
cleanrooms:ListTagsForResource,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:GetLogDelivery

Update

cleanrooms:UpdateMembership,
cleanrooms:GetMembership,
logs:CreateLogDelivery,
logs:GetLogDelivery,
logs:UpdateLogDelivery,
logs:DeleteLogDelivery,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:PutResourcePolicy,
logs:CreateLogGroup,
cleanrooms:ListTagsForResource,
cleanrooms:TagResource,
cleanrooms:UntagResource,
iam:PassRole

Delete

cleanrooms:DeleteMembership,
cleanrooms:GetMembership,
cleanrooms:ListMemberships,
cleanrooms:ListTagsForResource,
logs:ListLogDeliveries,
logs:DescribeLogGroups,
logs:DescribeResourcePolicies,
logs:GetLogDelivery

List

cleanrooms:ListMemberships