BatchStartViewerSessionRevocation
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.
- viewerSessions
-
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.
- errors
-
Each error object is related to a specific
channelArn
andviewerId
pair in the request.Type: Array of BatchStartViewerSessionRevocationError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
HTTP Status Code: 403
- PendingVerification
-
HTTP Status Code: 403
- ThrottlingException
-
HTTP Status Code: 429
- ValidationException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: