We are excited to announce our new API Documentation.
Optional CommonOptional ContentsMetadata about each object returned.
Optional Continuation If ContinuationToken was sent with the request, it is included in the
response.
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 key names in the XML response.
If you specify the encoding-type request parameter, Amazon S3 includes this
element in the response, and returns encoded key name values in the following response
elements:
Delimiter, Prefix, Key, and StartAfter.
Optional IsSet to false if all of the results were returned. Set to true
if more keys are available to return. If the number of results exceeds that specified by
MaxKeys, all of the results might not be returned.
Optional Key
KeyCount is the number of keys returned with this request.
KeyCount will always be less than or equal to the MaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or
fewer.
Optional MaxSets 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.
Optional NameThe bucket name.
When using this action with an access point, 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 Web Services 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.
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 Web Services 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.
Optional Next
NextContinuationToken is sent when isTruncated is true, which
means there are more keys in the bucket that can be listed. The next list requests to Amazon S3
can be continued with this NextContinuationToken.
NextContinuationToken is obfuscated and is not a real key
Optional PrefixKeys that begin with the indicated prefix.
Optional RequestIf present, indicates that the requester was successfully charged for the request.
Optional StartIf StartAfter was sent with the request, it is included in the response.
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
A response can contain
CommonPrefixesonly if you specify a delimiter.CommonPrefixescontains all (if there are any) keys betweenPrefixand the next occurrence of the string specified by a delimiter.CommonPrefixeslists 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.