Class: Aws::S3::Types::ListObjectsRequest

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 ListObjectsRequest data as a hash:

{
  bucket: "BucketName", # required
  delimiter: "Delimiter",
  encoding_type: "url", # accepts url
  marker: "Marker",
  max_keys: 1,
  prefix: "Prefix",
  request_payer: "requester", # accepts requester
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The name of the bucket containing the objects.

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#delimiterString

A delimiter is a character you use to group keys.

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_typeString

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#markerString

Specifies the key to start with when listing objects in a bucket.

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#max_keysInteger

Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Returns:

  • (Integer)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

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

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end

#request_payerString

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

Returns:

  • (String)


7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7167

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :request_payer)
  SENSITIVE = []
  include Aws::Structure
end