The BatchStartViewerSessionRevocation API from Amazon Interactive Video Service — 1 operation(s) for batchstartviewersessionrevocation.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-interactive-video-service-batchstartviewersessionrevocation-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: '2020-07-14'
x-release: v4
title: Amazon Interactive Video Service Batch Start Viewer Session…
description: 'Introduction
The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses.'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: ivs
x-aws-signingName: ivs
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ivs-2020-07-14.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://ivs.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon IVS multi-region endpoint
- url: https://ivs.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon IVS multi-region endpoint
- url: http://ivs.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
- url: https://ivs.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon IVS endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: BatchStartViewerSessionRevocation
paths:
/BatchStartViewerSessionRevocation:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: BatchStartViewerSessionRevocation
description: Performs StartViewerSessionRevocation on multiple channel ARN and viewer ID pairs simultaneously.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BatchStartViewerSessionRevocationResponse'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: PendingVerification
content:
application/json:
schema:
$ref: '#/components/schemas/PendingVerification'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- viewerSessions
properties:
viewerSessions:
description: Array of viewer sessions, one per channel-ARN and viewer-ID pair.
type: array
items:
$ref: '#/components/schemas/BatchStartViewerSessionRevocationViewerSession'
minItems: 1
maxItems: 20
summary: Amazon Interactive Video Service Batch Start Viewer Session Revocation
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- BatchStartViewerSessionRevocation
components:
schemas:
BatchStartViewerSessionRevocationErrors:
type: array
items:
$ref: '#/components/schemas/BatchStartViewerSessionRevocationError'
errorMessage:
type: string
errorCode:
type: string
BatchStartViewerSessionRevocationError:
type: object
required:
- channelArn
- viewerId
properties:
channelArn:
allOf:
- $ref: '#/components/schemas/ChannelArn'
- description: Channel ARN.
code:
allOf:
- $ref: '#/components/schemas/errorCode'
- description: Error code.
message:
allOf:
- $ref: '#/components/schemas/errorMessage'
- description: Error message, determined by the application.
viewerId:
allOf:
- $ref: '#/components/schemas/ViewerId'
- description: The ID of the viewer session to revoke.
description: Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
BatchStartViewerSessionRevocationViewerSession:
type: object
required:
- channelArn
- viewerId
properties:
channelArn:
allOf:
- $ref: '#/components/schemas/ChannelArn'
- description: The ARN of the channel associated with the viewer session to revoke.
viewerId:
allOf:
- $ref: '#/components/schemas/ViewerId'
- description: The ID of the viewer associated with the viewer session to revoke. Do not use this field for personally identifying, confidential, or sensitive information.
viewerSessionVersionsLessThanOrEqualTo:
allOf:
- $ref: '#/components/schemas/ViewerSessionVersion'
- description: '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.'
description: A viewer session to revoke in the call to <a>BatchStartViewerSessionRevocation</a>.
AccessDeniedException: {}
ThrottlingException: {}
ViewerId:
type: string
minLength: 1
maxLength: 40
ValidationException: {}
ChannelArn:
type: string
pattern: ^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$
minLength: 1
maxLength: 128
PendingVerification: {}
BatchStartViewerSessionRevocationResponse:
type: object
properties:
errors:
allOf:
- $ref: '#/components/schemas/BatchStartViewerSessionRevocationErrors'
- description: Each error object is related to a specific <code>channelArn</code> and <code>viewerId</code> pair in the request.
ViewerSessionVersion:
type: integer
minimum: 0
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/ivs/
x-hasEquivalentPaths: true