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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

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:

  • (Array<Types::CommonPrefix>)

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

#contentsArray<Types::Object>

Metadata about each object returned.

Returns:

  • (Array<Types::Object>)

    Metadata about each object returned.

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

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token.

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)

    A delimiter is a character you use to group keys.

#encoding_typeString

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

Possible values:

  • url

Returns:

  • (String)

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

#is_truncatedBoolean

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

Returns:

  • (Boolean)

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

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

    KeyCount is the number of keys returned with this request.

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

    Sets the maximum number of keys returned in the response.

#nameString

Name of the bucket to list.

Returns:

  • (String)

    Name of the bucket to list.

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

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

#prefixString

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

Returns:

  • (String)

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

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

    StartAfter is where you want Amazon S3 to start listing from.