IPWorks S3 2020 Node.js Edition

Questions / Feedback?

ListBuckets Method

Lists all buckets in the account.

Syntax

s3client.listBuckets([callback])

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 this 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 method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets* properties.

Note: When ServiceProvider is spLinode (9), this method only returns buckets located in the currently-selected Region, there is no way to retrieve a list all regions' buckets. Refer to the Linode section of the Region property's documentation for more information.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]