Class: AWS.BackupStorage

var params = {
  ChunkToken: 'STRING_VALUE', /* required */
  StorageJobId: 'STRING_VALUE' /* required */
};
backupstorage.getChunk(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StorageJobId — (String) Storage job id
  • ChunkToken — (String) Chunk token

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Data — (Buffer(Node.js), Typed Array(Browser), ReadableStream) Chunk data
    • Length — (Integer) Data length
    • Checksum — (String) Data checksum
    • ChecksumAlgorithm — (String) Checksum algorithm Possible values include:
      • "SHA256"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ObjectToken: 'STRING_VALUE', /* required */
  StorageJobId: 'STRING_VALUE' /* required */
};
backupstorage.getObjectMetadata(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StorageJobId — (String) Backup job id for the in-progress backup.
  • ObjectToken — (String) Object token.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MetadataString — (String) Metadata string.
    • MetadataBlob — (Buffer(Node.js), Typed Array(Browser), ReadableStream) Metadata blob.
    • MetadataBlobLength — (Integer) The size of MetadataBlob.
    • MetadataBlobChecksum — (String) MetadataBlob checksum.
    • MetadataBlobChecksumAlgorithm — (String) Checksum algorithm. Possible values include:
      • "SHA256"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ObjectToken: 'STRING_VALUE', /* required */
  StorageJobId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
backupstorage.listChunks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StorageJobId — (String) Storage job id
  • ObjectToken — (String) Object token
  • MaxResults — (Integer) Maximum number of chunks
  • NextToken — (String) Pagination token

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChunkList — (Array<map>) List of chunks
      • Index — required — (Integer) Chunk index
      • Length — required — (Integer) Chunk length
      • Checksum — required — (String) Chunk checksum
      • ChecksumAlgorithm — required — (String) Checksum algorithm Possible values include:
        • "SHA256"
      • ChunkToken — required — (String) Chunk token
    • NextToken — (String) Pagination token

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  StorageJobId: 'STRING_VALUE', /* required */
  CreatedAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  CreatedBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartingObjectName: 'STRING_VALUE',
  StartingObjectPrefix: 'STRING_VALUE'
};
backupstorage.listObjects(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • StorageJobId — (String) Storage job id
  • StartingObjectName — (String) Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL
  • StartingObjectPrefix — (String) Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
  • MaxResults — (Integer) Maximum objects count
  • NextToken — (String) Pagination token
  • CreatedBefore — (Date) (Optional) Created before filter
  • CreatedAfter — (Date) (Optional) Created after filter

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ObjectList — (Array<map>) Object list
      • Name — required — (String) Object name
      • ChunksCount — (Integer) Number of chunks in object
      • MetadataString — (String) Metadata string associated with the Object
      • ObjectChecksum — required — (String) Object checksum
      • ObjectChecksumAlgorithm — required — (String) Checksum algorithm Possible values include:
        • "SUMMARY"
      • ObjectToken — required — (String) Object token
    • NextToken — (String) Pagination token

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupJobId: 'STRING_VALUE', /* required */
  ObjectChecksum: 'STRING_VALUE', /* required */
  ObjectChecksumAlgorithm: SUMMARY, /* required */
  UploadId: 'STRING_VALUE', /* required */
  MetadataBlob: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  MetadataBlobChecksum: 'STRING_VALUE',
  MetadataBlobChecksumAlgorithm: SHA256,
  MetadataBlobLength: 'NUMBER_VALUE',
  MetadataString: 'STRING_VALUE'
};
backupstorage.notifyObjectComplete(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupJobId — (String) Backup job Id for the in-progress backup
  • UploadId — (String) Upload Id for the in-progress upload
  • ObjectChecksum — (String) Object checksum
  • ObjectChecksumAlgorithm — (String) Checksum algorithm Possible values include:
    • "SUMMARY"
  • MetadataString — (String) Optional metadata associated with an Object. Maximum string length is 256 bytes.
  • MetadataBlob — (Buffer, Typed Array, Blob, String, ReadableStream) Optional metadata associated with an Object. Maximum length is 4MB.
  • MetadataBlobLength — (Integer) The size of MetadataBlob.
  • MetadataBlobChecksum — (String) Checksum of MetadataBlob.
  • MetadataBlobChecksumAlgorithm — (String) Checksum algorithm. Possible values include:
    • "SHA256"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ObjectChecksum — (String) Object checksum
    • ObjectChecksumAlgorithm — (String) Checksum algorithm Possible values include:
      • "SUMMARY"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupJobId: 'STRING_VALUE', /* required */
  Checksum: 'STRING_VALUE', /* required */
  ChecksumAlgorithm: SHA256, /* required */
  ChunkIndex: 'NUMBER_VALUE', /* required */
  Data: Buffer.from('...') || 'STRING_VALUE' || streamObject, /* required */
  Length: 'NUMBER_VALUE', /* required */
  UploadId: 'STRING_VALUE' /* required */
};
backupstorage.putChunk(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupJobId — (String) Backup job Id for the in-progress backup.
  • UploadId — (String) Upload Id for the in-progress upload.
  • ChunkIndex — (Integer) Describes this chunk's position relative to the other chunks
  • Data — (Buffer, Typed Array, Blob, String, ReadableStream) Data to be uploaded
  • Length — (Integer) Data length
  • Checksum — (String) Data checksum
  • ChecksumAlgorithm — (String) Checksum algorithm Possible values include:
    • "SHA256"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ChunkChecksum — (String) Chunk checksum
    • ChunkChecksumAlgorithm — (String) Checksum algorithm Possible values include:
      • "SHA256"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupJobId: 'STRING_VALUE', /* required */
  ObjectName: 'STRING_VALUE', /* required */
  InlineChunk: Buffer.from('...') || 'STRING_VALUE' || streamObject,
  InlineChunkChecksum: 'STRING_VALUE',
  InlineChunkChecksumAlgorithm: 'STRING_VALUE',
  InlineChunkLength: 'NUMBER_VALUE',
  MetadataString: 'STRING_VALUE',
  ObjectChecksum: 'STRING_VALUE',
  ObjectChecksumAlgorithm: SUMMARY,
  ThrowOnDuplicate: true || false
};
backupstorage.putObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupJobId — (String) Backup job Id for the in-progress backup.
  • ObjectName — (String) The name of the Object to be uploaded.
  • MetadataString — (String) Store user defined metadata like backup checksum, disk ids, restore metadata etc.
  • InlineChunk — (Buffer, Typed Array, Blob, String, ReadableStream) Inline chunk data to be uploaded.
  • InlineChunkLength — (Integer) Length of the inline chunk data.
  • InlineChunkChecksum — (String) Inline chunk checksum
  • InlineChunkChecksumAlgorithm — (String) Inline chunk checksum algorithm
  • ObjectChecksum — (String) object checksum
  • ObjectChecksumAlgorithm — (String) object checksum algorithm Possible values include:
    • "SUMMARY"
  • ThrowOnDuplicate — (Boolean) Throw an exception if Object name is already exist.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InlineChunkChecksum — (String) Inline chunk checksum
    • InlineChunkChecksumAlgorithm — (String) Inline chunk checksum algorithm Possible values include:
      • "SHA256"
    • ObjectChecksum — (String) object checksum
    • ObjectChecksumAlgorithm — (String) object checksum algorithm Possible values include:
      • "SUMMARY"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  BackupJobId: 'STRING_VALUE', /* required */
  ObjectName: 'STRING_VALUE', /* required */
  ThrowOnDuplicate: true || false
};
backupstorage.startObject(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • BackupJobId — (String) Backup job Id for the in-progress backup
  • ObjectName — (String) Name for the object.
  • ThrowOnDuplicate — (Boolean) Throw an exception if Object name is already exist.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • UploadId — (String) Upload Id for a given upload.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.