class Aws::S3::Types::ListObjectsOutput


@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsOutput AWS API Documentation
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
for the request.
If present, indicates that the requester was successfully charged
@!attribute [rw] request_charged
@return [String]<br>: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-guidelines<br>[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html<br><br><br><br></note>
as ‘test_file%283%29.png`.
code values. For example, the object `test_file(3).png` will appear
in an object’s key name will be percent-encoded according to UTF-8
<note markdown=“1”> When using the URL encoding type, non-ASCII characters that are used
object key names, see [Object key naming guidelines].
the response. For more information about characters to avoid in
can add this parameter to request that Amazon S3 encode the keys in
from 0 to 10. For characters that aren’t supported in XML 1.0, you
parse certain characters, such as characters with an ASCII value
contain any Unicode character. However, the XML 1.0 parser can’t
the response. Responses are encoded only in UTF-8. An object key can
Encoding type used by Amazon S3 to encode the [object keys] in
@!attribute [rw] encoding_type
@return [Array<Types::CommonPrefix>]
count as a single return when calculating the number of returns.
‘notes/summer/`. All of the keys that roll up into a common prefix
(`/`), as in `notes/summer/july`, the common prefix is
For example, if the prefix is `notes/` and the delimiter is a slash
directory specified by `Prefix`.
`CommonPrefixes` lists keys that act like subdirectories in the
delimiter.
`Prefix` and the next occurrence of the string specified by the
`CommonPrefixes` contains all (if there are any) keys between
delimiter.
A response can contain `CommonPrefixes` only if you specify a
a single return when calculating the number of returns.
All of the keys (up to 1,000) rolled up in a common prefix count as
@!attribute [rw] common_prefixes
@return [Integer]
The maximum number of keys returned in the response body.
@!attribute [rw] max_keys
@return [String]
result counts as only one return against the `MaxKeys` value.
keys are not returned elsewhere in the response. Each rolled-up
result element in the `CommonPrefixes` collection. These rolled-up
first occurrence of the delimiter to be rolled up into a single
Causes keys that contain the same string between the prefix and the
@!attribute [rw] delimiter
@return [String]
Keys that begin with the indicated prefix.
@!attribute [rw] prefix
@return [String]
The bucket name.
@!attribute [rw] name
@return [Array<Types::Object>]
Metadata about each object returned.
@!attribute [rw] contents
@return [String]
</note>
the subsequent request to get the next set of object keys.
the last `Key` element in the response as the `marker` parameter in
`NextMarker` element and it is truncated, you can use the value of
parameter specified. If the response does not include the
<note markdown=“1”> This element is returned only if you have the `delimiter` request
of objects. Amazon S3 lists objects in alphabetical order.
the `marker` parameter in the subsequent request to get the next set
the response is `true`), you can use the key name in this field as
When the response is truncated (the `IsTruncated` element value in
@!attribute [rw] next_marker
@return [String]
the response if it was sent with the request.
Indicates where in the bucket listing begins. Marker is included in
@!attribute [rw] marker
@return [Boolean]
that satisfied the search criteria.
A flag that indicates whether Amazon S3 returned all of the results
@!attribute [rw] is_truncated