rooms

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

Overview

Name	rooms
Type	Resource
Id	aws.chime.rooms

Fields

The following fields are returned by SELECT queries:

get_room

Name	Datatype	Description
account_id	string	The Amazon Chime account ID. (pattern: <code>.\S.</code>)
created_by	string	The identifier of the room creator. (pattern: <code>.\S.</code>)
created_timestamp	string (date-time)	The room creation timestamp, in ISO 8601 format.
name	string	The room name.
room_id	string	The room ID. (pattern: <code>.\S.</code>)
updated_timestamp	string (date-time)	The room update timestamp, in ISO 8601 format.

list_rooms

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_room	select	account_id, room_id, region		Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.
list_rooms	select	account_id, region	member-id, max-results, next-token	Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
create_room	insert	account_id, region, Name		Creates a chat room for the specified Amazon Chime Enterprise account.
update_room	update	account_id, room_id, region		Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.
delete_room	delete	account_id, room_id, region		Deletes 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.
region	string	AWS region (default: us-east-1)
room_id	string	The chat room ID.
max-results	integer	The maximum number of results to return in a single call.
member-id	string	The member ID (user ID or bot ID).
next-token	string	The token to use to retrieve the next page of results.

SELECT examples

get_room

Retrieves room details, such as the room name, for a room in an Amazon Chime Enterprise account.

SELECT
account_id,
created_by,
created_timestamp,
name,
room_id,
updated_timestamp
FROM aws.chime.rooms
WHERE account_id = '{{ account_id }}' -- required
AND room_id = '{{ room_id }}' -- required
AND region = '{{ region }}' -- required
;

list_rooms

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

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

INSERT examples

create_room

Creates a chat room for the specified Amazon Chime Enterprise account.

INSERT INTO aws.chime.rooms (
Name,
ClientRequestToken,
account_id,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ ClientRequestToken }}',
'{{ account_id }}',
'{{ region }}'
RETURNING
room
;

Manifest

# Description fields are for documentation purposes
- name: rooms
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the rooms resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rooms resource.
  - name: Name
    value: "{{ Name }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"

UPDATE examples

update_room

Updates room details, such as the room name, for a room in an Amazon Chime Enterprise account.

UPDATE aws.chime.rooms
SET 
Name = '{{ Name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND room_id = '{{ room_id }}' --required
AND region = '{{ region }}' --required
RETURNING
room;

DELETE examples

delete_room

Deletes a chat room in an Amazon Chime Enterprise account.

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