Skip to content

put_hypervisor_property_mappings

put_hypervisor_property_mappings(
    hypervisor_arn: ServerArn,
    vmware_to_aws_tag_mappings: VmwareToAwsTagMappings,
    iam_role_arn: IamRoleArn,
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> PutHypervisorPropertyMappingsOutput

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

Parameters:

  • hypervisor_arn (ServerArn) –

    The Amazon Resource Name (ARN) of the hypervisor.

  • vmware_to_aws_tag_mappings (VmwareToAwsTagMappings) –

    This action requests the mappings of VMware tags to the Amazon Web Services tags.

  • iam_role_arn (IamRoleArn) –

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

Raises:

Source code in docs_src/capo_backup_gateway/_services/backup_gateway.py
def put_hypervisor_property_mappings(
    self,
    hypervisor_arn: "capo_backup_gateway.types.server_arn.ServerArn",
    vmware_to_aws_tag_mappings: "capo_backup_gateway.types.vmware_to_aws_tag_mappings.VmwareToAwsTagMappings",
    iam_role_arn: "capo_backup_gateway.types.iam_role_arn.IamRoleArn",
    *,
    config_overrides: Optional[BackupGatewayClientConfig] = None,
) -> "capo_backup_gateway.types.put_hypervisor_property_mappings_output.PutHypervisorPropertyMappingsOutput":
    """<p>This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.</p>

    Args:
        hypervisor_arn: <p>The Amazon Resource Name (ARN) of the hypervisor.</p>
        vmware_to_aws_tag_mappings: <p>This action requests the mappings of VMware tags to the Amazon Web Services tags.</p>
        iam_role_arn: <p>The Amazon Resource Name (ARN) of the IAM role.</p>

    Raises:
        capo_backup_gateway.errors.internal_server_exception.InternalServerException: <p>The operation did not succeed because an internal error occurred. Try again later.</p>
        capo_backup_gateway.errors.throttling_exception.ThrottlingException: <p>TPS has been limited to protect against intentional or unintentional high request volumes.</p>
        capo_backup_gateway.errors.validation_exception.ValidationException: <p>The operation did not succeed because a validation error occurred.</p>
        capo_backup_gateway.errors.access_denied_exception.AccessDeniedException: <p>The operation cannot proceed because you have insufficient permissions.</p>
        capo_backup_gateway.errors.conflict_exception.ConflictException: <p>The operation cannot proceed because it is not supported.</p>
        capo_backup_gateway.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action wasn't found.</p>
        capo_backup_gateway.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup_gateway.types.put_hypervisor_property_mappings_input.PutHypervisorPropertyMappingsInput]",
    ) -> OperationResponse[
        "capo_backup_gateway.types.put_hypervisor_property_mappings_output.PutHypervisorPropertyMappingsOutput"
    ]:
        import capo_backup_gateway._operations.backup_on_premises_v20210101.put_hypervisor_property_mappings

        output, http_response = (
            capo_backup_gateway._operations.backup_on_premises_v20210101.put_hypervisor_property_mappings.put_hypervisor_property_mappings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutHypervisorPropertyMappings")
    )
    input_: capo_backup_gateway.types.put_hypervisor_property_mappings_input.PutHypervisorPropertyMappingsInput = {
        "hypervisor_arn": hypervisor_arn,
        "vmware_to_aws_tag_mappings": vmware_to_aws_tag_mappings,
        "iam_role_arn": iam_role_arn,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output