room_memberships

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

Overview

Name	room_memberships
Type	Resource
Id	aws.chime.room_memberships

Fields

The following fields are returned by SELECT queries:

list_room_memberships

Name	Datatype	Description
next_token	string	The token to use to retrieve the next page of results.
room_memberships	array	The room membership details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_room_memberships	select	account_id, room_id, region	max-results, next-token	Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.
create_room_membership	insert	account_id, room_id, region, MemberId		Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
update_room_membership	update	account_id, room_id, member_id, region		Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.
delete_room_membership	delete	account_id, room_id, member_id, region		Removes a member from a chat room in an Amazon Chime Enterprise account.

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 Amazon Chime account ID.
member_id	string	The member ID (user ID or bot ID).
region	string	AWS region (default: us-east-1)
room_id	string	The room ID.
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token to use to retrieve the next page of results.

SELECT examples

list_room_memberships

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

SELECT
next_token,
room_memberships
FROM aws.chime.room_memberships
WHERE account_id = '{{ account_id }}' -- required
AND room_id = '{{ room_id }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_room_membership

Adds a member to a chat room in an Amazon Chime Enterprise account. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.

INSERT INTO aws.chime.room_memberships (
MemberId,
Role,
account_id,
room_id,
region
)
SELECT 
'{{ MemberId }}' /* required */,
'{{ Role }}',
'{{ account_id }}',
'{{ room_id }}',
'{{ region }}'
RETURNING
room_membership
;

Manifest

# Description fields are for documentation purposes
- name: room_memberships
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the room_memberships resource.
  - name: room_id
    value: "{{ room_id }}"
    description: Required parameter for the room_memberships resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the room_memberships resource.
  - name: MemberId
    value: "{{ MemberId }}"
  - name: Role
    value: "{{ Role }}"
    valid_values: ['Administrator', 'Member']

UPDATE examples

update_room_membership

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

UPDATE aws.chime.room_memberships
SET 
Role = '{{ Role }}'
WHERE 
account_id = '{{ account_id }}' --required
AND room_id = '{{ room_id }}' --required
AND member_id = '{{ member_id }}' --required
AND region = '{{ region }}' --required
RETURNING
room_membership;

DELETE examples

delete_room_membership

Removes a member from a chat room in an Amazon Chime Enterprise account.

DELETE FROM aws.chime.room_memberships
WHERE account_id = '{{ account_id }}' --required
AND room_id = '{{ room_id }}' --required
AND member_id = '{{ member_id }}' --required
AND region = '{{ region }}' --required
;