We are excited to announce our new API Documentation.
The output of ListObjectsCommand.
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
CommonPrefixes contains all (if there are any) keys between
Prefix and the next occurrence of the string specified by the
CommonPrefixes lists keys that act like subdirectories in the directory
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.
Metadata about each object returned.
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
Encoding type used by Amazon S3 to encode object keys in the response.
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.
The bucket name.
When the response is truncated (the
IsTruncated element value in the
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
parameter specified. If the response does not include the
element and it is truncated, you can use the value of the last
in the response as the
marker parameter in the subsequent request to get
the next set of object keys.
Keys that begin with the indicated prefix.
If present, indicates that the requester was successfully charged for the request.