:doc:`IoTThingsGraph <../../iotthingsgraph>` / Client / undeploy_system_instance

************************
undeploy_system_instance
************************



.. py:method:: IoTThingsGraph.Client.undeploy_system_instance(**kwargs)

  

  Removes a system instance from its target (Cloud or Greengrass).

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/UndeploySystemInstance>`_  


  **Request Syntax**
  ::

    response = client.undeploy_system_instance(
        id='string'
    )
    
  :type id: string
  :param id: 

    The ID of the system instance to remove from its target.

    

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

    
    ::

      {
          'summary': {
              'id': 'string',
              'arn': 'string',
              'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
              'target': 'GREENGRASS'|'CLOUD',
              'greengrassGroupName': 'string',
              'createdAt': datetime(2015, 1, 1),
              'updatedAt': datetime(2015, 1, 1),
              'greengrassGroupId': 'string',
              'greengrassGroupVersionId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **summary** *(dict) --* 

        An object that contains summary information about the system instance that was removed from its target.

        
        

        - **id** *(string) --* 

          The ID of the system instance.

          
        

        - **arn** *(string) --* 

          The ARN of the system instance.

          
        

        - **status** *(string) --* 

          The status of the system instance.

          
        

        - **target** *(string) --* 

          The target of the system instance.

          
        

        - **greengrassGroupName** *(string) --* 

          The ID of the Greengrass group where the system instance is deployed.

          
        

        - **createdAt** *(datetime) --* 

          The date when the system instance was created.

          
        

        - **updatedAt** *(datetime) --* 

          The date and time when the system instance was last updated.

          
        

        - **greengrassGroupId** *(string) --* 

          The ID of the Greengrass group where the system instance is deployed.

          
        

        - **greengrassGroupVersionId** *(string) --* 

          The version of the Greengrass group where the system instance is deployed.

          
    
  
  **Exceptions**
  
  *   :py:class:`IoTThingsGraph.Client.exceptions.InvalidRequestException`

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

  
  *   :py:class:`IoTThingsGraph.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTThingsGraph.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTThingsGraph.Client.exceptions.ResourceInUseException`

  