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::ListObjectsV2Output

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectsV2Output

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #common_prefixes ⇒ Array<Types::CommonPrefix>

  All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

• #contents ⇒ Array<Types::Object>

  Metadata about each object returned.

• #continuation_token ⇒ String

  If ContinuationToken was sent with the request, it is included in the response.

• #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 key names in the XML response.

• #is_truncated ⇒ Boolean

  Set to false if all of the results were returned.

• #key_count ⇒ Integer

  KeyCount is the number of keys returned with this request.

• #max_keys ⇒ Integer

  Sets the maximum number of keys returned in the response.

• #name ⇒ String

  The bucket name.

• #next_continuation_token ⇒ String

  NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed.

• #prefix ⇒ String

  Keys that begin with the indicated prefix.

• #start_after ⇒ String

  If StartAfter was sent with the request, it is included in the response.

Instance Attribute Details

#common_prefixes ⇒ Array<Types::CommonPrefix>

All of the keys (up to 1,000) rolled up into 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 a 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:

• (Array<Types::CommonPrefix>)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#contents ⇒ Array<Types::Object>

Metadata about each object returned.

Returns:

• (Array<Types::Object>)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#continuation_token ⇒ String

If ContinuationToken was sent with the request, it is included in the response.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  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.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#is_truncated ⇒ Boolean

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

Returns:

• (Boolean)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#key_count ⇒ Integer

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

Returns:

• (Integer)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#max_keys ⇒ Integer

Sets the maximum number of keys returned in the response. By default the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Returns:

• (Integer)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The bucket name.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#next_continuation_token ⇒ String

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

Keys that begin with the indicated prefix.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end

#start_after ⇒ String

If StartAfter was sent with the request, it is included in the response.

Returns:

• (String)

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

class ListObjectsV2Output < Struct.new(
  :is_truncated,
  :contents,
  :name,
  :prefix,
  :delimiter,
  :max_keys,
  :common_prefixes,
  :encoding_type,
  :key_count,
  :continuation_token,
  :next_continuation_token,
  :start_after)
  SENSITIVE = []
  include Aws::Structure
end