ListParticipantEventsCommand

Suggest an Edit

Lists events for a specified participant that occurred during a specified stage session.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IVSRealTimeClient, ListParticipantEventsCommand } from "@aws-sdk/client-ivs-realtime"; // ES Modules import
// const { IVSRealTimeClient, ListParticipantEventsCommand } = require("@aws-sdk/client-ivs-realtime"); // CommonJS import
const client = new IVSRealTimeClient(config);
const input = { // ListParticipantEventsRequest
  stageArn: "STRING_VALUE", // required
  sessionId: "STRING_VALUE", // required
  participantId: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListParticipantEventsCommand(input);
const response = await client.send(command);
// { // ListParticipantEventsResponse
//   events: [ // EventList // required
//     { // Event
//       name: "STRING_VALUE",
//       participantId: "STRING_VALUE",
//       eventTime: new Date("TIMESTAMP"),
//       remoteParticipantId: "STRING_VALUE",
//       errorCode: "INSUFFICIENT_CAPABILITIES" || "QUOTA_EXCEEDED" || "PUBLISHER_NOT_FOUND" || "BITRATE_EXCEEDED" || "RESOLUTION_EXCEEDED" || "STREAM_DURATION_EXCEEDED" || "INVALID_AUDIO_CODEC" || "INVALID_VIDEO_CODEC" || "INVALID_PROTOCOL" || "INVALID_STREAM_KEY" || "REUSE_OF_STREAM_KEY" || "B_FRAME_PRESENT" || "INVALID_INPUT" || "INTERNAL_SERVER_EXCEPTION",
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListParticipantEventsCommand Input

See ListParticipantEventsCommandInput for more details

Parameter
Type
Description
participantId
Required
string | undefined

Unique identifier for this participant. This is assigned by IVS and returned by CreateParticipantToken.

sessionId
Required
string | undefined

ID of a session within the stage.

stageArn
Required
string | undefined

Stage ARN.

maxResults
number | undefined

Maximum number of results to return. Default: 50.

nextToken
string | undefined

The first participant event to retrieve. This is used for pagination; see the nextToken response field.

ListParticipantEventsCommand Output

See ListParticipantEventsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
events
Required
Event[] | undefined

List of the matching events.

nextToken
string | undefined

If there are more events than maxResults, use nextToken in the request to get the next set.

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ValidationException
client
<p/>
IVSRealTimeServiceException
Base exception class for all service exceptions from IVSRealTime service.