:doc:`IVS <../../ivs>` / Client / start_viewer_session_revocation

*******************************
start_viewer_session_revocation
*******************************



.. py:method:: 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 <https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StartViewerSessionRevocation>`_  


  **Request Syntax**
  ::

    response = 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) --* 
  
  **Exceptions**
  
  *   :py:class:`IVS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IVS.Client.exceptions.InternalServerException`

  
  *   :py:class:`IVS.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`IVS.Client.exceptions.ValidationException`

  
  *   :py:class:`IVS.Client.exceptions.PendingVerification`

  
  *   :py:class:`IVS.Client.exceptions.ThrottlingException`

  