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

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

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

Overview

Note:

When passing ListObjectsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)

#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

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.

Possible values:

  • url

Returns:

  • (String)

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

#markerString

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

Returns:

  • (String)

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

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

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

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

Possible values:

  • requester

Returns:

  • (String)

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

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns: