ObjectComplianceLegalHold Property

Specifies whether or not an object is under legal hold.

Syntax

 wasabi.getObjectComplianceLegalHold([callback])
 wasabi.setObjectComplianceLegalHold( objectComplianceLegalHold, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getObjectComplianceLegalHold([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setObjectComplianceLegalHold([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Specifies whether or not an object is under legal hold.

If an object is under legal hold, it cannot be deleted regardless of whether or not its retention time has passed.

Refer to the UpdateCompliance documentation for more information about compliance.

This property is not available at design time.

Data Type

String