Class ListObjectsV2Request

Namespace

Amazon.S3.Model

Assembly

AWSSDK.S3.dll

Container for the parameters to the ListObjectsV2 operation. 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

:

• GetObject

• PutObject

• CreateBucket

public class ListObjectsV2Request : AmazonWebServiceRequest

Inheritance

object

ListObjectsV2Request

Constructors

ListObjectsV2Request()

public ListObjectsV2Request()

Properties

BucketName

Gets and sets the property BucketName.

Bucket name to list.

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

Property Value

string

ContinuationToken

Gets and sets the property 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

A delimiter is a character you use to group keys.

public string Delimiter { get; set; }

Property Value

string

Encoding

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 EncodingType Encoding { get; set; }

Property Value

EncodingType

ExpectedBucketOwner

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP

403 (Access Denied)

error.

public string ExpectedBucketOwner { get; set; }

Property Value

string

FetchOwner

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 bool FetchOwner { get; set; }

Property Value

bool

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

Prefix

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

public string Prefix { get; set; }

Property Value

string

RequestPayer

Gets and sets the property RequestPayer.

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

public RequestPayer RequestPayer { get; set; }

Property Value

RequestPayer

StartAfter

Gets and sets the property 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