AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#common_prefixesArray<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.

Returns:



8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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

#contentsArray<Types::Object>

Metadata about each object returned.

Returns:



8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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

#delimiterString

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.

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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_typeString

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

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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_truncatedBoolean

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

Returns:

  • (Boolean)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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

#markerString

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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_keysInteger

The maximum number of keys returned in the response body.

Returns:

  • (Integer)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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

#nameString

The bucket name.

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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_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 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.

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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

#prefixString

Keys that begin with the indicated prefix.

Returns:

  • (String)


8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8441

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