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

GetParticipant

Gets information about the specified participant token.

Request Syntax


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

{
   "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.

participantId

Unique identifier for the 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

{
   "participant": { 
      "attributes": { 
         "string" : "string" 
      },
      "browserName": "string",
      "browserVersion": "string",
      "firstJoinTime": "string",
      "ispName": "string",
      "osName": "string",
      "osVersion": "string",
      "participantId": "string",
      "protocol": "string",
      "published": boolean,
      "recordingS3BucketName": "string",
      "recordingS3Prefix": "string",
      "recordingState": "string",
      "sdkVersion": "string",
      "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.

participant

The participant that is returned.

Type: Participant object

Errors

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

AccessDeniedException

HTTP Status Code: 403

ResourceNotFoundException

HTTP Status Code: 404

ValidationException

HTTP Status Code: 400