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

StartViewerSessionRevocation

Starts the process of revoking the viewer session associated with a specified channel ARN and viewer ID. Optionally, you can provide a version to revoke viewer sessions less than and including that version. For instructions on associating a viewer ID with a viewer session, see Setting Up Private Channels.

Request Syntax


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

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

channelArn

The ARN of the channel associated with the viewer session to revoke.

Type: String

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

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

Required: Yes

viewerId

The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.

Type: String

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

Required: Yes

viewerSessionVersionsLessThanOrEqualTo

An optional filter on which versions of the viewer session to revoke. All versions less than or equal to the specified version will be revoked. Default: 0.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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.

Errors

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

AccessDeniedException

HTTP Status Code: 403

InternalServerException

HTTP Status Code: 500

PendingVerification

HTTP Status Code: 403

ResourceNotFoundException

HTTP Status Code: 404

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400