Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListObjectsV2Command

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

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 permissions 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.

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

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

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 command = new ListObjectsV2Command(input);
const response = await client.send(command);
see

ListObjectsV2CommandInput for command's input shape.

see

ListObjectsV2CommandOutput for command's response shape.

see

config for command's input shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

Readonly middlewareStack

middlewareStack: IMiddlewareStack<ListObjectsV2CommandInput, ListObjectsV2CommandOutput>