class Aws::S3::Types::ListObjectsRequest

@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
      expected_bucket_owner: "AccountId",
    }

@!attribute [rw] bucket

The name of the bucket containing the objects.

When using this action with an access point, you must direct
requests to the access point hostname. The access point hostname
takes the form
*AccessPointName*-*AccountId*.s3-accesspoint.*Region*.amazonaws.com.
When using this action with an access point through the Amazon Web
Services SDKs, you provide the access point ARN in place of the
bucket name. For more information about access point ARNs, see
[Using access points][1] in the *Amazon S3 User Guide*.

When using this action with Amazon S3 on Outposts, you must direct
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
takes the form
*AccessPointName*-*AccountId*.*outpostID*.s3-outposts.*Region*.amazonaws.com.
When using this action using S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts bucket ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see
[Using S3 on Outposts][2] in the *Amazon S3 User Guide*.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
[2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
@return [String]

@!attribute [rw] delimiter

A delimiter is a character you use to group keys.
@return [String]

@!attribute [rw] encoding_type

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.
@return [String]

@!attribute [rw] marker

Marker is where you want Amazon S3 to start listing from. Amazon S3
starts listing after this specified key. Marker can be any key in
the bucket.
@return [String]

@!attribute [rw] max_keys

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

@!attribute [rw] prefix

Limits the response to keys that begin with the specified prefix.
@return [String]

@!attribute [rw] request_payer

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.
@return [String]

@!attribute [rw] expected_bucket_owner

The account ID of the expected bucket owner. If the bucket is owned
by a different account, the request will fail with an HTTP `403
(Access Denied)` error.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation

Constants

SENSITIVE