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 object keys 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 response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects.
-
#prefix ⇒ String
Keys that begin with the indicated prefix.
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.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#contents ⇒ Array<Types::Object>
Metadata about each object returned.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) 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.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#encoding_type ⇒ String
Encoding type used by Amazon S3 to encode object keys in the response.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) 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.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) 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.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#max_keys ⇒ Integer
The maximum number of keys returned in the response body.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The bucket name.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#next_marker ⇒ String
When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |
#prefix ⇒ String
Keys that begin with the indicated prefix.
7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7792 class ListObjectsOutput < Struct.new( :is_truncated, :marker, :next_marker, :contents, :name, :prefix, :delimiter, :max_keys, :common_prefixes, :encoding_type) SENSITIVE = [] include Aws::Structure end |