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

***************************
delete_ingest_configuration
***************************



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

  

  Deletes a specified IngestConfiguration, so it can no longer be used to broadcast. An IngestConfiguration cannot be deleted if the publisher is actively streaming to a stage, unless ``force`` is set to ``true``.

  

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


  **Request Syntax**
  ::

    response = client.delete_ingest_configuration(
        arn='string',
        force=True|False
    )
    
  :type arn: string
  :param arn: **[REQUIRED]** 

    ARN of the IngestConfiguration.

    

  
  :type force: boolean
  :param force: 

    Optional field to force deletion of the IngestConfiguration. If this is set to ``true`` when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: ``false``.

    

  
  
  :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.ConflictException`

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

  