:doc:`IoT <../../iot>` / Client / describe_provisioning_template

******************************
describe_provisioning_template
******************************



.. py:method:: IoT.Client.describe_provisioning_template(**kwargs)

  

  Returns information about a provisioning template.

   

  Requires permission to access the `DescribeProvisioningTemplate <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/DescribeProvisioningTemplate>`_  


  **Request Syntax**
  ::

    response = client.describe_provisioning_template(
        templateName='string'
    )
    
  :type templateName: string
  :param templateName: **[REQUIRED]** 

    The name of the provisioning template.

    

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

    
    ::

      {
          'templateArn': 'string',
          'templateName': 'string',
          'description': 'string',
          'creationDate': datetime(2015, 1, 1),
          'lastModifiedDate': datetime(2015, 1, 1),
          'defaultVersionId': 123,
          'templateBody': 'string',
          'enabled': True|False,
          'provisioningRoleArn': 'string',
          'preProvisioningHook': {
              'payloadVersion': 'string',
              'targetArn': 'string'
          },
          'type': 'FLEET_PROVISIONING'|'JITP'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **templateArn** *(string) --* 

        The ARN of the provisioning template.

        
      

      - **templateName** *(string) --* 

        The name of the provisioning template.

        
      

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

        The description of the provisioning template.

        
      

      - **creationDate** *(datetime) --* 

        The date when the provisioning template was created.

        
      

      - **lastModifiedDate** *(datetime) --* 

        The date when the provisioning template was last modified.

        
      

      - **defaultVersionId** *(integer) --* 

        The default fleet template version ID.

        
      

      - **templateBody** *(string) --* 

        The JSON formatted contents of the provisioning template.

        
      

      - **enabled** *(boolean) --* 

        True if the provisioning template is enabled, otherwise false.

        
      

      - **provisioningRoleArn** *(string) --* 

        The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a device.

        
      

      - **preProvisioningHook** *(dict) --* 

        Gets information about a pre-provisioned hook.

        
        

        - **payloadVersion** *(string) --* 

          The payload that was sent to the target function.

           

          *Note:* Only Lambda functions are currently supported.

          
        

        - **targetArn** *(string) --* 

          The ARN of the target function.

           

          *Note:* Only Lambda functions are currently supported.

          
    
      

      - **type** *(string) --* 

        The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is ``FLEET_PROVISIONING``. For more information about provisioning template, see: `Provisioning template <https://docs.aws.amazon.com/iot/latest/developerguide/provision-template.html>`__.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

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

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

  
  *   :py:class:`IoT.Client.exceptions.UnauthorizedException`

  