:doc:`BackupGateway <../../backup-gateway>` / Client / get_hypervisor_property_mappings

********************************
get_hypervisor_property_mappings
********************************



.. py:method:: BackupGateway.Client.get_hypervisor_property_mappings(**kwargs)

  

  This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings>`_  


  **Request Syntax**
  ::

    response = client.get_hypervisor_property_mappings(
        HypervisorArn='string'
    )
    
  :type HypervisorArn: string
  :param HypervisorArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the hypervisor.

    

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

    
    ::

      {
          'HypervisorArn': 'string',
          'IamRoleArn': 'string',
          'VmwareToAwsTagMappings': [
              {
                  'AwsTagKey': 'string',
                  'AwsTagValue': 'string',
                  'VmwareCategory': 'string',
                  'VmwareTagName': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **HypervisorArn** *(string) --* 

        The Amazon Resource Name (ARN) of the hypervisor.

        
      

      - **IamRoleArn** *(string) --* 

        The Amazon Resource Name (ARN) of the IAM role.

        
      

      - **VmwareToAwsTagMappings** *(list) --* 

        This is a display of the mappings of on-premises VMware tags to the Amazon Web Services tags.

        
        

        - *(dict) --* 

          This displays the mapping of on-premises VMware tags to the corresponding Amazon Web Services tags.

          
          

          - **AwsTagKey** *(string) --* 

            The key part of the Amazon Web Services tag's key-value pair.

            
          

          - **AwsTagValue** *(string) --* 

            The value part of the Amazon Web Services tag's key-value pair.

            
          

          - **VmwareCategory** *(string) --* 

            The is the category of VMware.

            
          

          - **VmwareTagName** *(string) --* 

            This is the user-defined name of a VMware tag.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`BackupGateway.Client.exceptions.ValidationException`

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

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

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

  