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.
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class ListObjectsRequest : AmazonWebServiceRequest IRequestEvents
The ListObjectsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListObjectsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String | The name of the bucket containing the objects whose keys are to be listed. |
|
|
Delimiter | System.String | A delimiter is a character you use to group keys. |
|
|
Encoding | Amazon.S3.EncodingType | 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. |
|
|
Marker | System.String | Specifies the key to start with when listing objects in a bucket. |
|
|
MaxKeys | System.Int32 | Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more. |
|
|
Prefix | System.String | Limits the response to keys that begin with the specified prefix. |
Examples
This example shows how to list all objects in a bucket.
ListObjects sample
// Create a client
AmazonS3Client client = new AmazonS3Client();
// List all objects
ListObjectsRequest listRequest = new ListObjectsRequest
{
BucketName = "SampleBucket",
};
ListObjectsResponse listResponse;
do
{
// Get a list of objects
listResponse = client.ListObjects(listRequest);
foreach (S3Object obj in listResponse.S3Objects)
{
Console.WriteLine("Object - " + obj.Key);
Console.WriteLine(" Size - " + obj.Size);
Console.WriteLine(" LastModified - " + obj.LastModified);
Console.WriteLine(" Storage class - " + obj.StorageClass);
}
// Set the marker property
listRequest.Marker = listResponse.NextMarker;
} while (listResponse.IsTruncated);
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8