Class: Aws::S3::Types::ListObjectsOutput
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::ListObjectsOutput
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#common_prefixes ⇒ Array<Types::CommonPrefix>
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.
-
#contents ⇒ Array<Types::Object>
Metadata about each object returned.
-
#delimiter ⇒ String
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. -
#encoding_type ⇒ String
Encoding type used by Amazon S3 to encode the [object keys][1] in the response.
-
#is_truncated ⇒ Boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
-
#marker ⇒ String
Indicates where in the bucket listing begins.
-
#max_keys ⇒ Integer
The maximum number of keys returned in the response body.
-
#name ⇒ String
The bucket name.
-
#next_marker ⇒ String
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. -
#prefix ⇒ String
Keys that begin with the indicated prefix.
-
#request_charged ⇒ String
If present, indicates that the requester was successfully charged for the request.
Instance Attribute Details
#common_prefixes ⇒ Array<Types::CommonPrefix>
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 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.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#contents ⇒ Array<Types::Object>
Metadata about each object returned.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#delimiter ⇒ String
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 MaxKeys
value.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#encoding_type ⇒ String
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.
test_file(3).png
will appear
as test_file%283%29.png
.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#is_truncated ⇒ Boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#marker ⇒ String
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#max_keys ⇒ Integer
The maximum number of keys returned in the response body.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The bucket name.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#next_marker ⇒ String
When 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.
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.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#prefix ⇒ String
Keys that begin with the indicated prefix.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |
#request_charged ⇒ String
If present, indicates that the requester was successfully charged for the request.
11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 11176 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type, :request_charged) SENSITIVE = [] include Aws::Structure end |