Class: Aws::S3::Types::ListObjectsV2Request

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectsV2Request

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass ListObjectsV2Request data as a hash:

{
  bucket: "BucketName", # required
  delimiter: "Delimiter",
  encoding_type: "url", # accepts url
  max_keys: 1,
  prefix: "Prefix",
  continuation_token: "Token",
  fetch_owner: false,
  start_after: "StartAfter",
  request_payer: "requester", # accepts requester
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bucket ⇒ String

  Name of the bucket to list.

• #continuation_token ⇒ String

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

• #delimiter ⇒ String

  A delimiter is a character you use to group keys.

• #encoding_type ⇒ String

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

• #fetch_owner ⇒ Boolean

  The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.

• #max_keys ⇒ Integer

  Sets the maximum number of keys returned in the response.

• #prefix ⇒ String

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

• #request_payer ⇒ String

  Confirms that the requester knows that she or he will be charged for the list objects request in V2 style.

• #start_after ⇒ String

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

Instance Attribute Details

#bucket ⇒ String

Name of the bucket to list.

Returns:

• (String)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#continuation_token ⇒ String

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)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#delimiter ⇒ String

A delimiter is a character you use to group keys.

Returns:

• (String)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#encoding_type ⇒ String

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

Returns:

• (String)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#fetch_owner ⇒ Boolean

The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

Returns:

• (Boolean)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#max_keys ⇒ Integer

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

Returns:

• (Integer)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#prefix ⇒ String

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

Returns:

• (String)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

Returns:

• (String)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end

#start_after ⇒ String

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)

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

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  include Aws::Structure
end