AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListObjects operation.

Returns some or all (up to 1000) 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.ListObjectsV2Request

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public class ListObjectsV2Request : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The ListObjectsV2Request type exposes the following members

Constructors

NameDescription
Public Method ListObjectsV2Request()

Properties

NameTypeDescription
Public Property BucketName System.String

The name of the bucket to list.

Public Property ContinuationToken System.String

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

Public Property Delimiter System.String

A delimiter is a character you use to group keys.

Public Property Encoding Amazon.S3.EncodingType

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Public Property FetchOwner System.Boolean

The owner field is not present in ListObjectsV2 responses by default. If you want to return owner field with each key in the result then set this field to true. If not specified, the Owner field on S3Object will be null.

Public Property MaxKeys System.Int32

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Public Property Prefix System.String

Limits the response to keys that begin with the specified prefix.

Public Property RequestPayer Amazon.S3.RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Public Property StartAfter System.String

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket. Cannot be set at the same time as ContinuationToken.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone