Class: Aws::S3::Types::ListObjectsV2Output

Inherits:

Struct

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

Includes:

Aws::Structure

Defined in:

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) that share the same prefix are grouped together.

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

• #request_charged ⇒ String

  If present, indicates that the requester was successfully charged for the request.

• #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) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

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.

<note markdown=“1”> * **Directory buckets** - For directory buckets, only prefixes that

end in a delimiter (`/`) are supported.

• Directory buckets - When you query ‘ListObjectsV2` with a delimiter during in-progress multipart uploads, the `CommonPrefixes` response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see [Multipart Upload Overview] in the *Amazon S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html

Returns:

• (Array<Types::CommonPrefix>)

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

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#contents ⇒ Array<Types::Object>

Metadata about each object returned.

Returns:

• (Array<Types::Object>)

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

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#continuation_token ⇒ String

If ‘ContinuationToken` was sent with the request, it is included in the response. You can use the returned `ContinuationToken` for pagination of the list response. You can use this `ContinuationToken` for pagination of the list results.

Returns:

• (String)

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

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,
  :request_charged)
  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.

<note markdown=“1”> **Directory buckets** - For directory buckets, ‘/` is the only supported delimiter.

</note>

Returns:

• (String)

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

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,
  :request_charged)
  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 'lib/aws-sdk-s3/types.rb', line 10779

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,
  :request_charged)
  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 'lib/aws-sdk-s3/types.rb', line 10779

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,
  :request_charged)
  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 equal to the `MaxKeys` field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

Returns:

• (Integer)

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

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,
  :request_charged)
  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 'lib/aws-sdk-s3/types.rb', line 10779

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The bucket name.

Returns:

• (String)

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

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,
  :request_charged)
  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 'lib/aws-sdk-s3/types.rb', line 10779

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

Keys that begin with the indicated prefix.

<note markdown=“1”> **Directory buckets** - For directory buckets, only prefixes that end in a delimiter (‘/`) are supported.

</note>

Returns:

• (String)

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

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#start_after ⇒ String

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

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

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,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end