BatchStartViewerSessionRevocation - Amazon IVS


Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.

Request Syntax

POST /BatchStartViewerSessionRevocation HTTP/1.1 Content-type: application/json { "viewerSessions": [ { "channelArn": "string", "viewerId": "string", "viewerSessionVersionsLessThanOrEqualTo": number } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


Array of viewer sessions, one per channel-ARN and viewer-ID pair.

Type: Array of BatchStartViewerSessionRevocationViewerSession objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "errors": [ { "channelArn": "string", "code": "string", "message": "string", "viewerId": "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.


Each error object is related to a specific channelArn and viewerId pair in the request.

Type: Array of BatchStartViewerSessionRevocationError objects


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


HTTP Status Code: 400

See Also

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