You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#common_prefixesArray<Types::CommonPrefix>

Returns:



4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#contentsArray<Types::Object>

Returns:



4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#delimiterString

Returns:

  • (String)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#encoding_typeString

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

Returns:

  • (String)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#is_truncatedBoolean

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

Returns:

  • (Boolean)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#markerString

Returns:

  • (String)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#max_keysInteger

Returns:

  • (Integer)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#nameString

Returns:

  • (String)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#next_markerString

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)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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

#prefixString

Returns:

  • (String)


4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4759

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