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

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

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>

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter

Returns:



4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#contentsArray<Types::Object>

Metadata about each object returned.

Returns:



4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#continuation_tokenString

ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#encoding_typeString

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

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  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)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#key_countInteger

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

Returns:

  • (Integer)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#max_keysInteger

Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

Returns:

  • (Integer)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#nameString

Name of the bucket to list.

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#next_continuation_tokenString

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)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#prefixString

Limits the response to keys that begin with the specified prefix.

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end

#start_afterString

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

Returns:

  • (String)


4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4481

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)
  include Aws::Structure
end