Class: Aws::S3::Types::ListObjectsOutput

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectsOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Instance Attribute Summary

• #common_prefixes ⇒ Array<Types::CommonPrefix>
• #contents ⇒ Array<Types::Object>
• #delimiter ⇒ String
• #encoding_type ⇒ String

  Encoding type used by Amazon S3 to encode object keys in the response.

• #is_truncated ⇒ Boolean

  A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

• #marker ⇒ String
• #max_keys ⇒ Integer
• #name ⇒ String
• #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

Instance Attribute Details

#common_prefixes ⇒ Array<Types::CommonPrefix>

Returns:

• (Array<Types::CommonPrefix>)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#contents ⇒ Array<Types::Object>

Returns:

• (Array<Types::Object>)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#delimiter ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode object keys in the response.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#is_truncated ⇒ Boolean

A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

Returns:

• (Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#marker ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#max_keys ⇒ Integer

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#name ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  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 NextMaker 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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end

#prefix ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 5270

class ListObjectsOutput < Struct.new(
  :is_truncated,
  :marker,
  :next_marker,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type)
  include Aws::Structure
end