Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListParticipantEvents

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

Request Syntax


POST /ListParticipantEvents HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "participantId": "string",
   "sessionId": "string",
   "stageArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Maximum number of results to return. Default: 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=_-]*

Required: No

participantId

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Pattern: [a-zA-Z0-9-]*

Required: Yes

sessionId

ID of a session within the stage.

Type: String

Length Constraints: Fixed length of 16.

Pattern: st-[a-zA-Z0-9]+

Required: Yes

stageArn

Stage ARN.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "events": [ 
      { 
         "errorCode": "string",
         "eventTime": "string",
         "name": "string",
         "participantId": "string",
         "remoteParticipantId": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

events

List of the matching events.

Type: Array of Event objects

nextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [a-zA-Z0-9+/=_-]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ValidationException

HTTP Status Code: 400