IVS / Client / start_viewer_session_revocation

start_viewer_session_revocation#

IVS.Client.start_viewer_session_revocation(**kwargs)#

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

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

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IVS.Client.exceptions.InternalServerException

  • IVS.Client.exceptions.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.ThrottlingException