get_hypervisor_property_mappings

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

Request Syntax

response = client.get_hypervisor_property_mappings(
    HypervisorArn='string'
)

Parameters

HypervisorArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the hypervisor.

Return type

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

• BackupGateway.Client.exceptions.ValidationException
• BackupGateway.Client.exceptions.InternalServerException
• BackupGateway.Client.exceptions.ResourceNotFoundException
• BackupGateway.Client.exceptions.ThrottlingException