members

Creates, updates, deletes, gets or lists a members resource.

Overview

Name	members
Type	Resource
Id	aws.cleanrooms.members

Fields

The following fields are returned by SELECT queries:

list_members

Name	Datatype	Description
abilities	array	The abilities granted to the collaboration member.
account_id	string	The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID. (pattern: <code>\d+</code>)
create_time	string (date-time)	The time when the member was created.
display_name	string	The member's display name. (pattern: <code>(?!\s*$)[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDBFF-\uDC00\uDFFF\t]*</code>)
membership_arn	string	The unique ARN for the member's associated membership, if present. (pattern: <code>arn:aws:[\w]+:[\w]{2}-[\w]{4,9}-[\d]:[\d]{12}:membership/[\d\w-]+</code>)
membership_id	string	The unique ID for the member's associated membership, if present. (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
ml_abilities	object	The ML member abilities for a collaboration member.
payment_configuration	object	An object representing the collaboration member's payment responsibilities set by the collaboration creator.
status	string	The status of the member. (INVITED, ACTIVE, LEFT, REMOVED)
update_time	string (date-time)	The time the member metadata was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_members	select	collaboration_identifier, region	nextToken, maxResults	Lists all members within a collaboration.
delete_member	delete	collaboration_identifier, account_id, region		Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The account ID of the member to remove.
collaboration_identifier	string	The unique identifier for the associated collaboration.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.
nextToken	string	The pagination token that's used to fetch the next set of results.

SELECT examples

list_members

Lists all members within a collaboration.

SELECT
abilities,
account_id,
create_time,
display_name,
membership_arn,
membership_id,
ml_abilities,
payment_configuration,
status,
update_time
FROM aws.cleanrooms.members
WHERE collaboration_identifier = '{{ collaboration_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

DELETE examples

delete_member

Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.

DELETE FROM aws.cleanrooms.members
WHERE collaboration_identifier = '{{ collaboration_identifier }}' --required
AND account_id = '{{ account_id }}' --required
AND region = '{{ region }}' --required
;