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.

Returns information about the ListObjects response and response metadata.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.S3.Model.ListObjectsV2Response

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

Syntax

C#
public class ListObjectsV2Response : AmazonWebServiceResponse

The ListObjectsV2Response type exposes the following members

Constructors

NameDescription
Public Method ListObjectsV2Response()

Properties

NameTypeDescription
Public Property CommonPrefixes System.Collections.Generic.List<System.String>

Gets and sets the CommonPrefixes property. CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
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

Gets and sets the Delimiter property. Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection.

Public Property Encoding Amazon.S3.EncodingType

Encoding type used by Amazon S3 to encode object keys in the response.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property IsTruncated System.Boolean

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

Public Property KeyCount System.Int32

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to MaxKeys field.

Public Property MaxKeys System.Int32

Gets and sets the MaxKeys property. This is max number of object keys returned by the list operation.

Public Property Name System.String

Gets and sets the Name property. The name of the bucket that was listed.

Public Property NextContinuationToken System.String

NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next ListObjectV2 call to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key.

Public Property Prefix System.String

Gets and sets the Prefix property.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property S3Objects System.Collections.Generic.List<Amazon.S3.Model.S3Object>

Gets and sets the S3Objects property. Metadata about each object returned.

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.

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