Table of Contents

Class ListObjectsRequest

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

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.

public class ListObjectsRequest : AmazonWebServiceRequest
Inheritance
ListObjectsRequest

Constructors

ListObjectsRequest()

public ListObjectsRequest()

Properties

BucketName

The name of the bucket containing the objects.

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 BucketName { 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

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

Marker

Specifies the key to start with when listing objects in a bucket.

public string Marker { get; set; }

Property Value

string

MaxKeys

Sets the maximum number of keys returned in the response. 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

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

Property Value

RequestPayer