ListObjectsResponse Class | AWS SDK for .NET Version 4

Returns information about the ListObjects response and response metadata.

In this article ▶

Inheritance Hierarchy

System.Object
Amazon.Runtime.AmazonWebServiceResponse
Amazon.S3.Model.ListObjectsResponse

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

public class ListObjectsResponse : AmazonWebServiceResponse

The ListObjectsResponse type exposes the following members

Constructors

	Name	Description
	ListObjectsResponse()

Properties

Name	Type	Description
CommonPrefixes	System.Collections.Generic.List<System.String>	Gets and sets the property CommonPrefixes. All of the keys (up to 1,000) rolled up in 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 the 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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
ContentLength	System.Int64	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Delimiter	System.String	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.
Encoding	Amazon.S3.EncodingType	Gets and sets the property Encoding. Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines. When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object `test_file(3).png` will appear as `test_file%283%29.png`.
HttpStatusCode	System.Net.HttpStatusCode	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
IsTruncated	System.Nullable<System.Boolean>	Gets and sets the property IsTruncated. A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
Marker	System.String	Gets and sets the property Marker. Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
MaxKeys	System.Nullable<System.Int32>	Gets and sets the property MaxKeys. The maximum number of keys returned in the response body.
Name	System.String	Gets and sets the property Name. The bucket name.
NextMarker	System.String	Gets and sets the property NextMarker. When the response is truncated (the `IsTruncated` element value in the response is `true`), you can use the key name in this field as the `marker` parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order. This element is returned only if you have the `delimiter` request parameter specified. If the response does not include the `NextMarker` element and it is truncated, you can use the value of the last `Key` element in the response as the `marker` parameter in the subsequent request to get the next set of object keys.
Prefix	System.String	Gets and sets the property Prefix. Keys that begin with the indicated prefix.
RequestCharged	Amazon.S3.RequestCharged	Gets and sets the property RequestCharged.
ResponseMetadata	Amazon.Runtime.ResponseMetadata	Inherited from Amazon.Runtime.AmazonWebServiceResponse.
S3Objects	System.Collections.Generic.List<Amazon.S3.Model.S3Object>	Gets and sets the property S3Objects. Metadata about each object returned. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

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 = "amzn-s3-demo-bucket",
};

ListObjectsResponse listResponse;
do
{
    // Get a list of objects
    listResponse = await client.ListObjectsAsync(listRequest);

    if (listResponse.S3Objects != null)
    {
        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.GetValueOrDefault());

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer