Class ListObjectsV2CommandProtected

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide.

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

• GetObject

• PutObject

• CreateBucket

Example

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

import { S3Client, ListObjectsV2Command } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, ListObjectsV2Command } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const input = { // ListObjectsV2Request
  Bucket: "STRING_VALUE", // required
  Delimiter: "STRING_VALUE",
  EncodingType: "url",
  MaxKeys: Number("int"),
  Prefix: "STRING_VALUE",
  ContinuationToken: "STRING_VALUE",
  FetchOwner: true || false,
  StartAfter: "STRING_VALUE",
  RequestPayer: "requester",
  ExpectedBucketOwner: "STRING_VALUE",
  OptionalObjectAttributes: [ // OptionalObjectAttributesList
    "RestoreStatus",
  ],
};
const command = new ListObjectsV2Command(input);
const response = await client.send(command);
// { // ListObjectsV2Output
//   IsTruncated: true || false,
//   Contents: [ // ObjectList
//     { // Object
//       Key: "STRING_VALUE",
//       LastModified: new Date("TIMESTAMP"),
//       ETag: "STRING_VALUE",
//       ChecksumAlgorithm: [ // ChecksumAlgorithmList
//         "CRC32" || "CRC32C" || "SHA1" || "SHA256",
//       ],
//       Size: Number("long"),
//       StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW",
//       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",
//   KeyCount: Number("int"),
//   ContinuationToken: "STRING_VALUE",
//   NextContinuationToken: "STRING_VALUE",
//   StartAfter: "STRING_VALUE",
//   RequestCharged: "requester",
// };

Param

ListObjectsV2CommandInput

Returns

ListObjectsV2CommandOutput

See

• ListObjectsV2CommandInput for command's input shape.
• ListObjectsV2CommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

NoSuchBucket (client fault)

The specified bucket does not exist.

Throws

S3ServiceException

Base exception class for all service exceptions from S3 service.

Example

To get object list

// The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
const input = {
  "Bucket": "DOC-EXAMPLE-BUCKET",
  "MaxKeys": "2"
};
const command = new ListObjectsV2Command(input);
const response = await client.send(command);
/* response ==
{
  "Contents": [
    {
      "ETag": "\"70ee1738b6b21e2c8a43f3a5ab0eee71\"",
      "Key": "happyface.jpg",
      "LastModified": "2014-11-21T19:40:05.000Z",
      "Size": 11,
      "StorageClass": "STANDARD"
    },
    {
      "ETag": "\"becf17f89c30367a9a44495d62ed521a-1\"",
      "Key": "test.jpg",
      "LastModified": "2014-05-02T04:51:50.000Z",
      "Size": 4192256,
      "StorageClass": "STANDARD"
    }
  ],
  "IsTruncated": true,
  "KeyCount": "2",
  "MaxKeys": "2",
  "Name": "DOC-EXAMPLE-BUCKET",
  "NextContinuationToken": "1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==",
  "Prefix": ""
}
*/
// example id: to-get-object-list