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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListObjectsRequest

Includes:

Aws::Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bucket ⇒ String
• #delimiter ⇒ String

  A delimiter is a character you use to group keys.

• #encoding_type ⇒ String

  Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use.

• #marker ⇒ String

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

• #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.

Instance Attribute Details

#bucket ⇒ String

Returns:

• (String)

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

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :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 5227

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

#encoding_type ⇒ String

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)

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

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

#marker ⇒ String

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

Returns:

• (String)

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

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :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 5227

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :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 5227

class ListObjectsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :marker,
  :max_keys,
  :prefix,
  :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. Bucket owners need not specify this parameter in their requests.

Returns:

• (String)

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

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