:doc:`ivsrealtime <../../ivs-realtime>` / Client / disconnect_participant

**********************
disconnect_participant
**********************



.. py:method:: ivsrealtime.Client.disconnect_participant(**kwargs)

  

  Disconnects a specified participant from a specified stage. If the participant is publishing using an  IngestConfiguration, DisconnectParticipant also updates the ``stageArn`` in the IngestConfiguration to be an empty string.

  

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


  **Request Syntax**
  ::

    response = client.disconnect_participant(
        stageArn='string',
        participantId='string',
        reason='string'
    )
    
  :type stageArn: string
  :param stageArn: **[REQUIRED]** 

    ARN of the stage to which the participant is attached.

    

  
  :type participantId: string
  :param participantId: **[REQUIRED]** 

    Identifier of the participant to be disconnected. IVS assigns this; it is returned by  CreateParticipantToken (for streams using WebRTC ingest) or  CreateIngestConfiguration (for streams using RTMP ingest).

    

  
  :type reason: string
  :param reason: 

    Description of why this participant is being disconnected.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`ivsrealtime.Client.exceptions.ResourceNotFoundException`

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

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

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

  