Class ListObjectsV2Response

Namespace

Amazon.S3.Model

Assembly

AWSSDK.S3.dll

Returns information about the ListObjects response and response metadata.

public class ListObjectsV2Response : AmazonWebServiceResponse

Inheritance

object

ListObjectsV2Response

Constructors

ListObjectsV2Response()

public ListObjectsV2Response()

Properties

CommonPrefixes

Gets and sets the property CommonPrefixes.

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

A response can contain

CommonPrefixes

only if you specify a delimiter.

CommonPrefixes

contains all (if there are any) keys between

Prefix

and the next occurrence of the string specified by a delimiter.

CommonPrefixes

lists keys that act like subdirectories in the directory specified by

Prefix

.

For example, if the prefix is

notes/

and the delimiter is a slash (

/

) as in

notes/summer/july

, the common prefix is

notes/summer/

. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

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 property Delimiter.

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. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the

MaxKeys

value.

public string Delimiter { get; set; }

Property Value

string

Encoding

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

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key,

and

StartAfter

.

public EncodingType Encoding { get; set; }

Property Value

EncodingType

IsTruncated

Gets and sets the property IsTruncated.

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

public bool IsTruncated { get; set; }

Property Value

bool

KeyCount

Gets and sets the property KeyCount.

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

MaxKeys

field. Say you ask for 50 keys, your result will include 50 keys or fewer.

public int KeyCount { get; set; }

Property Value

int

MaxKeys

Gets and sets the property MaxKeys.

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

public int MaxKeys { get; set; }

Property Value

int

Name

Gets and sets the property Name.

The bucket name.

When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.

public string Name { get; set; }

Property Value

string

NextContinuationToken

Gets and sets the property NextContinuationToken.

NextContinuationToken

is sent when

isTruncated

is true, which means there are more keys in the bucket that can be listed. The next list requests 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 property Prefix.

Keys that begin with the indicated prefix.

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

Gets and sets the property StartAfter.

If StartAfter was sent with the request, it is included in the response.

public string StartAfter { get; set; }

Property Value

string