BackupGateway / Client / put_hypervisor_property_mappings

put_hypervisor_property_mappings#

BackupGateway.Client.put_hypervisor_property_mappings(**kwargs)#

This action sets 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.put_hypervisor_property_mappings(
    HypervisorArn='string',
    IamRoleArn='string',
    VmwareToAwsTagMappings=[
        {
            'AwsTagKey': 'string',
            'AwsTagValue': 'string',
            'VmwareCategory': 'string',
            'VmwareTagName': 'string'
        },
    ]
)
Parameters:

  • HypervisorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the hypervisor.

  • IamRoleArn (string) –

    [REQUIRED]

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

  • VmwareToAwsTagMappings (list) –

    [REQUIRED]

    This action requests 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) – [REQUIRED]

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

      • AwsTagValue (string) – [REQUIRED]

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

      • VmwareCategory (string) – [REQUIRED]

        The is the category of VMware.

      • VmwareTagName (string) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'HypervisorArn': 'string'
}

Response Structure

  • (dict) –

    • HypervisorArn (string) –

      The Amazon Resource Name (ARN) of the hypervisor.

Exceptions

  • BackupGateway.Client.exceptions.ValidationException

  • BackupGateway.Client.exceptions.ConflictException

  • BackupGateway.Client.exceptions.InternalServerException

  • BackupGateway.Client.exceptions.AccessDeniedException

  • BackupGateway.Client.exceptions.ResourceNotFoundException

  • BackupGateway.Client.exceptions.ThrottlingException