ListObjects
Note
This operation is not supported for directory buckets.
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.
Important
This action 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
:
Request Syntax
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
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-optional-object-attributes: OptionalObjectAttributes
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The name of the bucket containing the objects.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the formatbucket-base-name--zone-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 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.
Note
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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 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.Required: Yes
- delimiter
-
A delimiter is a character that you use to group keys.
- encoding-type
-
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.
Note
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 astest_file%283%29.png
.Valid Values:
url
- marker
-
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
- max-keys
-
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.
- prefix
-
Limits the response to keys that begin with the specified prefix.
- x-amz-expected-bucket-owner
-
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied). - x-amz-optional-object-attributes
-
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Valid Values:
RestoreStatus
- x-amz-request-payer
-
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
x-amz-request-charged: RequestCharged
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<NextMarker>string</NextMarker>
<Contents>
<ChecksumAlgorithm>string</ChecksumAlgorithm>
...
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<RestoreStatus>
<IsRestoreInProgress>boolean</IsRestoreInProgress>
<RestoreExpiryDate>timestamp</RestoreExpiryDate>
</RestoreStatus>
<Size>long</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>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Note
This functionality is not supported for directory buckets.
Valid Values:
requester
The following data is returned in XML format by the service.
- ListBucketResult
-
Root level tag for the ListBucketResult parameters.
Required: Yes
- 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 betweenPrefix
and the next occurrence of the string specified by the delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
), as innotes/summer/july
, the common prefix isnotes/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
- Contents
-
Metadata about each object returned.
Type: Array of Object data types
- 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 theMaxKeys
value.Type: String
- EncodingType
-
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.
Note
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 astest_file%283%29.png
.Type: String
Valid Values:
url
- IsTruncated
-
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
Type: Boolean
- Marker
-
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
Type: String
- MaxKeys
-
The maximum number of keys returned in the response body.
Type: Integer
- Name
-
The bucket name.
Type: String
- NextMarker
-
When the response is truncated (the
IsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.Note
This element is returned only if you have the
delimiter
request parameter specified. If the response does not include theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys.Type: String
- Prefix
-
Keys that begin with the indicated prefix.
Type: String
Errors
- NoSuchBucket
-
The specified bucket does not exist.
HTTP Status Code: 404
Examples
Sample Request
This request returns the objects in BucketName
.
GET / HTTP/1.1 Host: BucketName.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain
Sample Response
This example illustrates one usage of ListObjects.
<?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>bucket</Name> <Prefix/> <Marker/> <MaxKeys>1000</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>my-image.jpg</Key> <LastModified>2009-10-12T17:50:30.000Z</LastModified> <ETag>"fba9dede5f27731c9771645a39863328"</ETag> <Size>434234</Size> <StorageClass>STANDARD</StorageClass> <Owner> <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID> <DisplayName>mtd@amazon.com</DisplayName> </Owner> </Contents> <Contents> <Key>my-third-image.jpg</Key> <LastModified>2009-10-12T17:50:30.000Z</LastModified> <ETag>"1b2cf535f27731c974343645a3985328"</ETag> <Size>64994</Size> <StorageClass>STANDARD_IA</StorageClass> <Owner> <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID> <DisplayName>mtd@amazon.com</DisplayName> </Owner> </Contents> </ListBucketResult>
Sample Request: Using request parameters
This example lists up to 40 keys in the quotes
bucket that start with
N
and occur lexicographically after Ned
.
GET /?prefix=N&marker=Ned&max-keys=40 HTTP/1.1 Host: quotes.s3.<Region>.amazonaws.com Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
Sample Response
This example illustrates one usage of ListObjects.
HTTP/1.1 200 OK x-amz-id-2: gyB+3jRPnrkN98ZajxHXr3u7EFM67bNgSAxexeEHndCX/7GRnfTXxReKUQF28IfP x-amz-request-id: 3B3C7C725673C630 Date: Wed, 01 Mar 2006 12:00:00 GMT Content-Type: application/xml Content-Length: 302 Connection: close Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>quotes</Name> <Prefix>N</Prefix> <Marker>Ned</Marker> <MaxKeys>40</MaxKeys> <IsTruncated>false</IsTruncated> <Contents> <Key>Nelson</Key> <LastModified>2006-01-01T12:00:00.000Z</LastModified> <ETag>"828ef3fdfa96f00ad9f27c383fc9ac7f"</ETag> <Size>5</Size> <StorageClass>STANDARD</StorageClass> <Owner> <ID>bcaf161ca5fb16fd081034f</ID> <DisplayName>webfile</DisplayName> </Owner> </Contents> <Contents> <Key>Neo</Key> <LastModified>2006-01-01T12:00:00.000Z</LastModified> <ETag>"828ef3fdfa96f00ad9f27c383fc9ac7f"</ETag> <Size>4</Size> <StorageClass>STANDARD</StorageClass> <Owner> <ID>bcaf1ffd86a5fb16fd081034f</ID> <DisplayName>webfile</DisplayName> </Owner> </Contents> </ListBucketResult>
Sample Request: Using a prefix and delimiter
For this example, we assume that you have the following keys in your bucket:
-
sample.jpg
-
photos/2006/January/sample.jpg
-
photos/2006/February/sample2.jpg
-
photos/2006/February/sample3.jpg
-
photos/2006/February/sample4.jpg
The following GET
request specifies the delimiter
parameter with a value of /
.
GET /?delimiter=/ HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
Sample Response
The key sample.jpg
does not contain the delimiter character, and Amazon S3
returns it in the Contents
element in the response. However, all of the
other keys contain the delimiter character. Amazon S3 groups these keys and returns a
single CommonPrefixes
element with the Prefix
value
photos/
, which is a substring from the beginning of these keys to the
first occurrence of the specified delimiter.
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>example-bucket</Name> <Prefix></Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <Delimiter>/</Delimiter> <IsTruncated>false</IsTruncated> <Contents> <Key>sample.jpg</Key> <LastModified>2011-02-26T01:56:20.000Z</LastModified> <ETag>"bf1d737a4d46a19f3bced6905cc8b902"</ETag> <Size>142863</Size> <Owner> <ID>canonical-user-id</ID> <DisplayName>display-name</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> </Contents> <CommonPrefixes> <Prefix>photos/</Prefix> </CommonPrefixes> </ListBucketResult>
Sample Request
The following GET
request specifies the delimiter
parameter with the value /
, and the prefix
parameter with
the value photos/2006/
.
GET /?prefix=photos/2006/&delimiter=/ HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Wed, 01 Mar 2006 12:00:00 GMT Authorization: authorization string
Sample Response
In response, Amazon S3 returns only the keys that start with the specified prefix. Amazon S3
uses the delimiter character to group keys that contain the same substring until the
first occurrence of the delimiter character after the specified prefix. For each such
key group, Amazon S3 returns one CommonPrefixes
element in the response. The
keys grouped under this CommonPrefixes
element are not returned
elsewhere in the response. The value returned in the CommonPrefixes
element is a substring that starts at the beginning of the key and ends at the first
occurrence of the specified delimiter after the prefix.
<ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Name>example-bucket</Name> <Prefix>photos/2006/</Prefix> <Marker></Marker> <MaxKeys>1000</MaxKeys> <Delimiter>/</Delimiter> <IsTruncated>false</IsTruncated> <CommonPrefixes> <Prefix>photos/2006/February/</Prefix> </CommonPrefixes> <CommonPrefixes> <Prefix>photos/2006/January/</Prefix> </CommonPrefixes> </ListBucketResult>
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: