Class ListObjectVersionsCommand

Example

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

import { S3Client, ListObjectVersionsCommand } from "ibm-cos-sdk-v2"; // ES Modules import
// const { S3Client, ListObjectVersionsCommand } = 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 = { // ListObjectVersionsRequest
  Bucket: "STRING_VALUE", // required
  Delimiter: "STRING_VALUE",
  EncodingType: "url",
  KeyMarker: "STRING_VALUE",
  MaxKeys: Number("int"),
  Prefix: "STRING_VALUE",
  VersionIdMarker: "STRING_VALUE",
  ExpectedBucketOwner: "STRING_VALUE",
  RequestPayer: "requester",
  OptionalObjectAttributes: [ // OptionalObjectAttributesList
    "RestoreStatus",
  ],
};
const command = new ListObjectVersionsCommand(input);
const response = await client.send(command);
// { // ListObjectVersionsOutput
//   IsTruncated: true || false,
//   KeyMarker: "STRING_VALUE",
//   VersionIdMarker: "STRING_VALUE",
//   NextKeyMarker: "STRING_VALUE",
//   NextVersionIdMarker: "STRING_VALUE",
//   Versions: [ // ObjectVersionList
//     { // ObjectVersion
//       ETag: "STRING_VALUE",
//       ChecksumAlgorithm: [ // ChecksumAlgorithmList
//         "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
//       ],
//       ChecksumType: "COMPOSITE" || "FULL_OBJECT",
//       Size: Number("long"),
//       StorageClass: "STANDARD",
//       Key: "STRING_VALUE",
//       VersionId: "STRING_VALUE",
//       IsLatest: true || false,
//       LastModified: new Date("TIMESTAMP"),
//       Owner: { // Owner
//         DisplayName: "STRING_VALUE",
//         ID: "STRING_VALUE",
//       },
//       RestoreStatus: { // RestoreStatus
//         IsRestoreInProgress: true || false,
//         RestoreExpiryDate: new Date("TIMESTAMP"),
//       },
//     },
//   ],
//   DeleteMarkers: [ // DeleteMarkers
//     { // DeleteMarkerEntry
//       Owner: {
//         DisplayName: "STRING_VALUE",
//         ID: "STRING_VALUE",
//       },
//       Key: "STRING_VALUE",
//       VersionId: "STRING_VALUE",
//       IsLatest: true || false,
//       LastModified: 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 object versions

// The following example returns versions of an object with specific key name prefix.
const input = {
  Bucket: "examplebucket",
  Prefix: "HappyFace.jpg"
};
const command = new ListObjectVersionsCommand(input);
const response = await client.send(command);
/* response is
{
  Versions: [
    {
      ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
      IsLatest: true,
      Key: "HappyFace.jpg",
      LastModified: "2016-12-15T01:19:41.000Z",
      Owner: {
        DisplayName: "owner-display-name",
        ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      },
      Size: 3191,
      StorageClass: "STANDARD",
      VersionId: "null"
    },
    {
      ETag: `"6805f2cfc46c0f04559748bb039d69ae"`,
      IsLatest: false,
      Key: "HappyFace.jpg",
      LastModified: "2016-12-13T00:58:26.000Z",
      Owner: {
        DisplayName: "owner-display-name",
        ID: "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
      },
      Size: 3191,
      StorageClass: "STANDARD",
      VersionId: "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k"
    }
  ]
}
*/
Copy