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

ListParticipants

Lists all participants in a specified stage session.

Request Syntax


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

{
   "filterByPublished": boolean,
   "filterByState": "string",
   "filterByUserId": "string",
   "maxResults": number,
   "nextToken": "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.

filterByPublished

Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

Type: Boolean

Required: No

filterByState

Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request.

Type: String

Valid Values: CONNECTED | DISCONNECTED

Required: No

filterByUserId

Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, or filterByState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.

Type: String

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

Required: No

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 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

sessionId

ID of the 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

{
   "nextToken": "string",
   "participants": [ 
      { 
         "firstJoinTime": "string",
         "participantId": "string",
         "published": boolean,
         "state": "string",
         "userId": "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.

nextToken

If there are more participants 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+/=_-]*$

participants

List of the matching participants (summary information only).

Type: Array of ParticipantSummary objects

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