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

*****************************
describe_managed_job_template
*****************************



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

  

  View details of a managed job template.

  

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


  **Request Syntax**
  ::

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

    The unique name of a managed job template, which is required.

    

  
  :type templateVersion: string
  :param templateVersion: 

    An optional parameter to specify version of a managed template. If not specified, the pre-defined default version is returned.

    

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

    
    ::

      {
          'templateName': 'string',
          'templateArn': 'string',
          'description': 'string',
          'templateVersion': 'string',
          'environments': [
              'string',
          ],
          'documentParameters': [
              {
                  'key': 'string',
                  'description': 'string',
                  'regex': 'string',
                  'example': 'string',
                  'optional': True|False
              },
          ],
          'document': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The unique name of a managed template, such as ``AWS-Reboot``.

        
      

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

        The unique Amazon Resource Name (ARN) of the managed template.

        
      

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

        The unique description of a managed template.

        
      

      - **templateVersion** *(string) --* 

        The version for a managed template.

        
      

      - **environments** *(list) --* 

        A list of environments that are supported with the managed job template.

        
        

        - *(string) --* 
    
      

      - **documentParameters** *(list) --* 

        A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

         

        .. note::

          

          ``documentParameters`` can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

          

        
        

        - *(dict) --* 

          A map of key-value pairs containing the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

           

          .. note::

            

            ``documentParameters`` can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

            

          
          

          - **key** *(string) --* 

            Key of the map field containing the patterns that need to be replaced in a managed template job document schema.

            
          

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

            Description of the map field containing the patterns that need to be replaced in a managed template job document schema.

            
          

          - **regex** *(string) --* 

            A regular expression of the patterns that need to be replaced in a managed template job document schema.

            
          

          - **example** *(string) --* 

            An example illustrating a pattern that need to be replaced in a managed template job document schema.

            
          

          - **optional** *(boolean) --* 

            Specifies whether a pattern that needs to be replaced in a managed template job document schema is optional or required.

            
      
    
      

      - **document** *(string) --* 

        The document schema for a managed job template.

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

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

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

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

  