Table of Contents

Class ListObjectsV2Response

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Returns information about the ListObjects response and response metadata.

public class ListObjectsV2Response : AmazonWebServiceResponse
Inheritance
ListObjectsV2Response

Constructors

ListObjectsV2Response()

public ListObjectsV2Response()

Properties

CommonPrefixes

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 List<string> CommonPrefixes { get; set; }

Property Value

List<string>

ContinuationToken

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 string ContinuationToken { get; set; }

Property Value

string

Delimiter

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 string Delimiter { get; set; }

Property Value

string

Remarks

These rolled-up keys are not returned elsewhere in the response.

Encoding

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

public EncodingType Encoding { get; set; }

Property Value

EncodingType

IsTruncated

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

public bool IsTruncated { get; set; }

Property Value

bool

KeyCount

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

public int KeyCount { get; set; }

Property Value

int

MaxKeys

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

public int MaxKeys { get; set; }

Property Value

int

Name

Bucket name.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

public string Name { get; set; }

Property Value

string

NextContinuationToken

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 string NextContinuationToken { get; set; }

Property Value

string

Prefix

Gets and sets the Prefix property.

public string Prefix { get; set; }

Property Value

string

S3Objects

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

public List<S3Object> S3Objects { get; set; }

Property Value

List<S3Object>

StartAfter

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.

public string StartAfter { get; set; }

Property Value

string