:doc:`IoTFleetWise <../../iotfleetwise>` / Client / get_state_template

******************
get_state_template
******************



.. py:method:: IoTFleetWise.Client.get_state_template(**kwargs)

  

  Retrieves information about a state template.

   

  .. warning::

     

    Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see `Amazon Web Services Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`__ in the *Amazon Web Services IoT FleetWise Developer Guide*.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/GetStateTemplate>`_  


  **Request Syntax**
  ::

    response = client.get_state_template(
        identifier='string'
    )
    
  :type identifier: string
  :param identifier: **[REQUIRED]** 

    The unique ID of the state template.

    

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

    
    ::

      {
          'name': 'string',
          'arn': 'string',
          'description': 'string',
          'signalCatalogArn': 'string',
          'stateTemplateProperties': [
              'string',
          ],
          'dataExtraDimensions': [
              'string',
          ],
          'metadataExtraDimensions': [
              'string',
          ],
          'creationTime': datetime(2015, 1, 1),
          'lastModificationTime': datetime(2015, 1, 1),
          'id': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **name** *(string) --* 

        The name of the state template.

        
      

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

        The Amazon Resource Name (ARN) of the state template.

        
      

      - **description** *(string) --* 

        A brief description of the state template.

        
      

      - **signalCatalogArn** *(string) --* 

        The ARN of the signal catalog associated with the state template.

        
      

      - **stateTemplateProperties** *(list) --* 

        A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

        
        

        - *(string) --* 
    
      

      - **dataExtraDimensions** *(list) --* 

        A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

         

        Default: An empty array

        
        

        - *(string) --* 
    
      

      - **metadataExtraDimensions** *(list) --* 

        A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

         

        Default: An empty array

        
        

        - *(string) --* 
    
      

      - **creationTime** *(datetime) --* 

        The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).

        
      

      - **lastModificationTime** *(datetime) --* 

        The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

        
      

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

        The unique ID of the state template.

        
  
  **Exceptions**
  
  *   :py:class:`IoTFleetWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.AccessDeniedException`

  