AWS API Changes

2023/06/27 - Amazon Interactive Video Service - 2 new api methods

Changes IVS customers can now revoke the viewer session associated with an auth token, to prevent and stop playback using that token.

BatchStartViewerSessionRevocation (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.batch_start_viewer_session_revocation(
    viewerSessions=[
        {
            'channelArn': 'string',
            'viewerId': 'string',
            'viewerSessionVersionsLessThanOrEqualTo': 123
        },
    ]
)

type viewerSessions:

list

param viewerSessions:

[REQUIRED]

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

(dict) --

A viewer session to revoke in the call to BatchStartViewerSessionRevocation.
- channelArn (string) -- [REQUIRED]
  
  The ARN of the channel associated with the viewer session to revoke.
- viewerId (string) -- [REQUIRED]
  
  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 (integer) --
  
  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.

rtype:

dict

returns:

Response Syntax

{
    'errors': [
        {
            'channelArn': 'string',
            'code': 'string',
            'message': 'string',
            'viewerId': 'string'
        },
    ]
}

Response Structure

(dict) --
- errors (list) --
  
  Each error object is related to a specific channelArn and viewerId pair in the request.
  - (dict) --
    
    Error for a request in the batch for BatchStartViewerSessionRevocation. Each error is related to a specific channel-ARN and viewer-ID pair.
    - channelArn (string) --
      
      Channel ARN.
    - code (string) --
      
      Error code.
    - message (string) --
      
      Error message, determined by the application.
    - viewerId (string) --
      
      The ID of the viewer session to revoke.

StartViewerSessionRevocation (new)

Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.start_viewer_session_revocation(
    channelArn='string',
    viewerId='string',
    viewerSessionVersionsLessThanOrEqualTo=123
)

type channelArn:

string

param channelArn:

[REQUIRED]

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

type viewerId:

string

param viewerId:

[REQUIRED]

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

integer

param 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.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --