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

*******************
get_system_instance
*******************



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

  

  Gets a system instance.

  

  .. 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/GetSystemInstance>`_  


  **Request Syntax**
  ::

    response = client.get_system_instance(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the system deployment instance. This value is returned by ``CreateSystemInstance``.

     

    The ID should be in the following format.

     

    ``urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME``

    

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

    
    ::

      {
          'description': {
              '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'
              },
              'definition': {
                  'language': 'GRAPHQL',
                  'text': 'string'
              },
              's3BucketName': 'string',
              'metricsConfiguration': {
                  'cloudMetricEnabled': True|False,
                  'metricRuleRoleArn': 'string'
              },
              'validatedNamespaceVersion': 123,
              'validatedDependencyRevisions': [
                  {
                      'id': 'string',
                      'revisionNumber': 123
                  },
              ],
              'flowActionsRoleArn': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **description** *(dict) --* 

        An object that describes the system instance.

        
        

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

          An object that contains summary information about a system instance.

          
          

          - **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.

            
      
        

        - **definition** *(dict) --* 

          A document that defines an entity.

          
          

          - **language** *(string) --* 

            The language used to define the entity. ``GRAPHQL`` is the only valid value.

            
          

          - **text** *(string) --* 

            The GraphQL text that defines the entity.

            
      
        

        - **s3BucketName** *(string) --* 

          The Amazon Simple Storage Service bucket where information about a system instance is stored.

          
        

        - **metricsConfiguration** *(dict) --* 

          An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

          
          

          - **cloudMetricEnabled** *(boolean) --* 

            A Boolean that specifies whether cloud metrics are collected.

            
          

          - **metricRuleRoleArn** *(string) --* 

            The ARN of the role that is used to collect cloud metrics.

            
      
        

        - **validatedNamespaceVersion** *(integer) --* 

          The version of the user's namespace against which the system instance was validated.

          
        

        - **validatedDependencyRevisions** *(list) --* 

          A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

          
          

          - *(dict) --* 

            An object that contains the ID and revision number of a workflow or system that is part of a deployment.

            
            

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

              The ID of the workflow or system.

              
            

            - **revisionNumber** *(integer) --* 

              The revision number of the workflow or system.

              
        
      
        

        - **flowActionsRoleArn** *(string) --* 

          The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

          
    
  
  **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`

  