:doc:`MigrationHubOrchestrator <../../migrationhuborchestrator>` / Client / get_template

************
get_template
************



.. py:method:: MigrationHubOrchestrator.Client.get_template(**kwargs)

  

  Get the template you want to use for creating a migration workflow.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/migrationhuborchestrator-2021-08-28/GetTemplate>`_  


  **Request Syntax**
  ::

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

    The ID of the template.

    

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

    
    ::

      {
          'id': 'string',
          'templateArn': 'string',
          'name': 'string',
          'description': 'string',
          'inputs': [
              {
                  'inputName': 'string',
                  'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP',
                  'required': True|False
              },
          ],
          'tools': [
              {
                  'name': 'string',
                  'url': 'string'
              },
          ],
          'creationTime': datetime(2015, 1, 1),
          'owner': 'string',
          'status': 'CREATED'|'READY'|'PENDING_CREATION'|'CREATING'|'CREATION_FAILED',
          'statusMessage': 'string',
          'templateClass': 'string',
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ID of the template.

        
      

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

        >The Amazon Resource Name (ARN) of the migration workflow template. The format for an Migration Hub Orchestrator template ARN is ``arn:aws:migrationhub-orchestrator:region:account:template/template-abcd1234``. For more information about ARNs, see `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`__ in the *AWS General Reference*.

        
      

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

        The name of the template.

        
      

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

        The time at which the template was last created.

        
      

      - **inputs** *(list) --* 

        The inputs provided for the creation of the migration workflow.

        
        

        - *(dict) --* 

          The input parameters of a template.

          
          

          - **inputName** *(string) --* 

            The name of the template.

            
          

          - **dataType** *(string) --* 

            The data type of the template input.

            
          

          - **required** *(boolean) --* 

            Determine if an input is required from the template.

            
      
    
      

      - **tools** *(list) --* 

        List of AWS services utilized in a migration workflow.

        
        

        - *(dict) --* 

          List of AWS services utilized in a migration workflow.

          
          

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

            The name of an AWS service.

            
          

          - **url** *(string) --* 

            The URL of an AWS service.

            
      
    
      

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

        The time at which the template was last created.

        
      

      - **owner** *(string) --* 

        The owner of the migration workflow template.

        
      

      - **status** *(string) --* 

        The status of the template.

        
      

      - **statusMessage** *(string) --* 

        The status message of retrieving migration workflow templates.

        
      

      - **templateClass** *(string) --* 

        The class of the migration workflow template. The available template classes are:

         

        
        * A2C
         
        * MGN
         
        * SAP_MULTI
         
        * SQL_EC2
         
        * SQL_RDS
         
        * VMIE
        

        
      

      - **tags** *(dict) --* 

        The tags added to the migration workflow template.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`MigrationHubOrchestrator.Client.exceptions.ThrottlingException`

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

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

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

  