Returns some or all (up to 1,000) 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. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.
The following operations are related to ListObjects:
GET /?delimiter=Delimiter&encoding-type=EncodingType&marker=Marker&max-keys=MaxKeys&prefix=Prefix HTTP/1.1 Host: Bucket.s3.amazonaws.com x-amz-request-payer: RequestPayer
URI Request Parameters
The request uses the following URI parameters.
The name of the bucket containing the objects.
A delimiter is a character you use to group keys.
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.
Valid Values: url
Specifies the key to start with when listing objects in a bucket.
Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
Limits the response to keys that begin with the specified prefix.
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.
Valid Values: requester
The request does not have a request body.
HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult> <IsTruncated>boolean</IsTruncated> <Marker>string</Marker> <NextMarker>string</NextMarker> <Contents> <ETag>string</ETag> <Key>string</Key> <LastModified>timestamp</LastModified> <Owner> <DisplayName>string</DisplayName> <ID>string</ID> </Owner> <Size>integer</Size> <StorageClass>string</StorageClass> </Contents> ... <Name>string</Name> <Prefix>string</Prefix> <Delimiter>string</Delimiter> <MaxKeys>integer</MaxKeys> <CommonPrefixes> <Prefix>string</Prefix> </CommonPrefixes> ... <EncodingType>string</EncodingType> </ListBucketResult>
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
Root level tag for the ListBucketResult parameters.
All of the keys 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.
Type: Array of CommonPrefix data types
Metadata about each object returned.
Type: Array of Object data types
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 type used by Amazon S3 to encode object keys in the response.
Valid Values: url
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
The maximum number of keys returned in the response body.
When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
Keys that begin with the indicated prefix.