We are excited to announce our new API Documentation.
Protected
Optional
CommonAll 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.
Optional
ContentsMetadata about each object returned.
Optional
DelimiterCauses 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.
Optional
EncodingEncoding type used by Amazon S3 to encode object keys in the response.
Optional
IsA flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
Optional
MarkerIndicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
Optional
MaxThe maximum number of keys returned in the response body.
Optional
NameThe bucket name.
Optional
NextWhen 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.
Optional
PrefixKeys that begin with the indicated prefix.
Optional
RequestIf present, indicates that the requester was successfully charged for the request.
The output of ListObjectsCommand.