VersionId Property
The object version to make requests against.
Syntax
amazons3.getVersionId([callback]) amazons3.setVersionId( versionId, [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 getVersionId([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 setVersionId([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
This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:
- CopyObject (to copy from a specific object version)
- DeleteObject
- GetLink (to build a link for a specific object version)
- GetObject
- GetObjectInfo
- SendCustomRequest
- UpdateObjectACL
Refer to Amazon's Versioning documentation for more information about versioning.
This property is not available at design time.
Data Type
String