DisconnectParticipant - Amazon IVS


Disconnects a specified participant and revokes the participant permanently from a specified stage.

Request Syntax

POST /DisconnectParticipant HTTP/1.1 Content-type: application/json { "participantId": "string", "reason": "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.


Identifier of the participant to be disconnected. This is assigned by IVS and returned by CreateParticipantToken.

Type: String

Required: Yes


Description of why this participant is being disconnected.

Type: String

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

Required: No


ARN of the stage to which the participant is attached.

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

Response Elements

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


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


HTTP Status Code: 403


HTTP Status Code: 403


HTTP Status Code: 404


HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: