:doc:`MediaConnect <../../mediaconnect>` / Client / deregister_gateway_instance

***************************
deregister_gateway_instance
***************************



.. py:method:: MediaConnect.Client.deregister_gateway_instance(**kwargs)

  

  Deregisters an instance. Before you deregister an instance, all bridges running on the instance must be stopped. If you want to deregister an instance without stopping the bridges, you must use the --force option.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mediaconnect-2018-11-14/DeregisterGatewayInstance>`_  


  **Request Syntax**
  ::

    response = client.deregister_gateway_instance(
        Force=True|False,
        GatewayInstanceArn='string'
    )
    
  :type Force: boolean
  :param Force: 

    Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.

    

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

    The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.

    

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

    
    ::

      {
          'GatewayInstanceArn': 'string',
          'InstanceState': 'REGISTERING'|'ACTIVE'|'DEREGISTERING'|'DEREGISTERED'|'REGISTRATION_ERROR'|'DEREGISTRATION_ERROR'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **GatewayInstanceArn** *(string) --* 

        The ARN of the instance.

        
      

      - **InstanceState** *(string) --* 

        The status of the instance.

        
  
  **Exceptions**
  
  *   :py:class:`MediaConnect.Client.exceptions.BadRequestException`

  
  *   :py:class:`MediaConnect.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`MediaConnect.Client.exceptions.ConflictException`

  
  *   :py:class:`MediaConnect.Client.exceptions.ForbiddenException`

  
  *   :py:class:`MediaConnect.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MediaConnect.Client.exceptions.NotFoundException`

  
  *   :py:class:`MediaConnect.Client.exceptions.ServiceUnavailableException`

  