Class ListObjectsCommandProtected

Returns some or all (up to 1,000) of the objects in a bucket. 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. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

• ListObjectsV2

• GetObject

• PutObject

• CreateBucket

• ListBuckets

Example

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

import { S3Client, ListObjectsCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, ListObjectsCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const command = new ListObjectsCommand(input);
const response = await client.send(command);

See

• ListObjectsCommandInput for command's input shape.
• ListObjectsCommandOutput for command's response shape.
• config for S3Client's config shape.

Throws

NoSuchBucket (client fault)

The specified bucket does not exist.

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 ==
{
  "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=="
}
*/
// example id: to-list-objects-in-a-bucket-1473447646507