participant_events
Creates, updates, deletes, gets or lists a participant_events resource.
Overview
| Name | participant_events |
| Type | Resource |
| Id | aws.ivs_realtime.participant_events |
Fields
The following fields are returned by SELECT queries:
- list_participant_events
| Name | Datatype | Description |
|---|---|---|
events | array | List of the matching events. |
next_token | string | If there are more events than maxResults, use nextToken in the request to get the next set. (pattern: <code>[a-zA-Z0-9+/=_-]*</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_participant_events | select | region | Lists events for a specified participant that occurred during a specified stage session. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_participant_events
Lists events for a specified participant that occurred during a specified stage session.
SELECT
events,
next_token
FROM aws.ivs_realtime.participant_events
WHERE region = '{{ region }}' -- required
;