IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

NotifyEventType Property

This property specifies the type of enabled notifications for the vault.

Syntax

 amazonglacier.getNotifyEventType([callback])
 amazonglacier.setNotifyEventType( notifyEventType, [callback])

Possible Values

  0 (etBoth), 
  1 (etArchiveRetrievalCompleted), 
  2 (etInventoryRetrievalCompleted)

Default Value

0

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 getNotifyEventType([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 setNotifyEventType([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 specifies the type of enabled notifications for the vault. Possible values are:

0 (etBoth - default) Notifications for both inventory and archive retrieval jobs.
1 (etArchiveRetrievalCompleted) Notifications are sent when an archive retrieval job is complete.
2 (etInventoryRetrievalCompleted) Notifications are sent when an inventory retrieval job is complete.

This property is not available at design time.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]