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

*******************
get_system_template
*******************



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

  

  Gets a system.

  

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


  **Request Syntax**
  ::

    response = client.get_system_template(
        id='string',
        revisionNumber=123
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the system to get. This ID must be in the user's namespace.

     

    The ID should be in the following format.

     

    ``urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME``

    

  
  :type revisionNumber: integer
  :param revisionNumber: 

    The number that specifies the revision of the system to get.

    

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

    
    ::

      {
          'description': {
              'summary': {
                  'id': 'string',
                  'arn': 'string',
                  'revisionNumber': 123,
                  'createdAt': datetime(2015, 1, 1)
              },
              'definition': {
                  'language': 'GRAPHQL',
                  'text': 'string'
              },
              'validatedNamespaceVersion': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        An object that contains summary data about the system.

        
        

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

          An object that contains summary information about a system.

          
          

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

            The ID of the system.

            
          

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

            The ARN of the system.

            
          

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

            The revision number of the system.

            
          

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

            The date when the system was created.

            
      
        

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

          The definition document of a system.

          
          

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

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

            
          

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

            The GraphQL text that defines the entity.

            
      
        

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

          The namespace version against which the system was validated. Use this value in your system instance.

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

  