Class ListObjectsCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, ListObjectsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListObjectsCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
// import type { S3ClientConfig } from "ibm-cos-sdk-v2";
const config = {}; // type is S3ClientConfig
const client = new S3Client(config);
const input = { // ListObjectsRequest
  Bucket: "STRING_VALUE", // required
  Delimiter: "STRING_VALUE",
  EncodingType: "url",
  Marker: "STRING_VALUE",
  MaxKeys: Number("int"),
  Prefix: "STRING_VALUE",
  RequestPayer: "requester",
  ExpectedBucketOwner: "STRING_VALUE",
  OptionalObjectAttributes: [ // OptionalObjectAttributesList
    "RestoreStatus",
  ],
};
const command = new ListObjectsCommand(input);
const response = await client.send(command);
// { // ListObjectsOutput
//   IBMSSEKPEnabled: true || false,
//   IBMSSEKPCustomerRootKeyCrn: "STRING_VALUE",
//   IsTruncated: true || false,
//   Marker: "STRING_VALUE",
//   NextMarker: "STRING_VALUE",
//   Contents: [ // ObjectList
//     { // Object
//       Key: "STRING_VALUE",
//       LastModified: new Date("TIMESTAMP"),
//       ETag: "STRING_VALUE",
//       ChecksumAlgorithm: [ // ChecksumAlgorithmList
//         "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
//       ],
//       ChecksumType: "COMPOSITE" || "FULL_OBJECT",
//       Size: Number("long"),
//       StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE" || "FSX_OPENZFS" || "FSX_ONTAP",
//       Owner: { // Owner
//         DisplayName: "STRING_VALUE",
//         ID: "STRING_VALUE",
//       },
//       RestoreStatus: { // RestoreStatus
//         IsRestoreInProgress: true || false,
//         RestoreExpiryDate: new Date("TIMESTAMP"),
//       },
//     },
//   ],
//   Name: "STRING_VALUE",
//   Prefix: "STRING_VALUE",
//   Delimiter: "STRING_VALUE",
//   MaxKeys: Number("int"),
//   CommonPrefixes: [ // CommonPrefixList
//     { // CommonPrefix
//       Prefix: "STRING_VALUE",
//     },
//   ],
//   EncodingType: "url",
//   RequestCharged: "requester",
// };

Copy

Example: To list objects in a bucket

// The following example list two objects in a bucket.
const input = {
  Bucket: "examplebucket",
  MaxKeys: 2
};
const command = new ListObjectsCommand(input);
const response = await client.send(command);
/* response is
{
  Contents: [
    {
      ETag: `"70ee1738b6b21e2c8a43f3a5ab0eee71"`,
      Key: "example1.jpg",
      LastModified: "2014-11-21T19:40:05.000Z",
      Owner: {
        DisplayName: "myname",
        ID: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      },
      Size: 11,
      StorageClass: "STANDARD"
    },
    {
      ETag: `"9c8af9a76df052144598c115ef33e511"`,
      Key: "example2.jpg",
      LastModified: "2013-11-15T01:10:49.000Z",
      Owner: {
        DisplayName: "myname",
        ID: "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      },
      Size: 713193,
      StorageClass: "STANDARD"
    }
  ],
  NextMarker: "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ=="
}
*/
Copy