Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListObjectsCommand

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:

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.

see

ListObjectsCommandOutput for command's response shape.

see

config for S3Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    Returns ListObjectsCommand

  • Parameters

    • input: ListObjectsCommandInput

    Returns ListObjectsCommand

Properties

Readonly input

input: ListObjectsCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListObjectsCommandInput, ListObjectsCommandOutput>