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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Name of the bucket to list.

Returns:

  • (String)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  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)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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

#encoding_typeString

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

Returns:

  • (String)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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

#fetch_ownerBoolean

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)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  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)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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

#prefixString

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

Returns:

  • (String)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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

#request_payerString

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)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

class ListObjectsV2Request < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :max_keys,
  :prefix,
  :continuation_token,
  :fetch_owner,
  :start_after,
  :request_payer)
  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)


4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4560

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