class Aws::S3::Types::ListObjectsRequest
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/ListObjectsRequest AWS API Documentation
@return [String]
(Access Denied)‘ error.
by a different account, the request will fail with an HTTP `403
The account ID of the expected bucket owner. If the bucket is owned
@!attribute [rw] expected_bucket_owner
@return [String]
parameter in their requests.
the list objects request. Bucket owners need not specify this
Confirms that the requester knows that she or he will be charged for
@!attribute [rw] request_payer
@return [String]
Limits the response to keys that begin with the specified prefix.
@!attribute [rw] prefix
@return [Integer]
fewer keys but will never contain more.
the action returns up to 1,000 key names. The response might contain
Sets the maximum number of keys returned in the response. By default
@!attribute [rw] max_keys
@return [String]
Specifies the key to start with when listing objects in a bucket.
@!attribute [rw] marker
@return [String]
parameter to request that Amazon S3 encode the keys in the response.
characters that are not supported in XML 1.0, you can add this
characters, such as characters with an ASCII value from 0 to 10. For
Unicode character; however, XML 1.0 parser cannot parse some
specifies the encoding method to use. An object key may contain any
Requests Amazon S3 to encode the object keys in the response and
@!attribute [rw] encoding_type
@return [String]
A delimiter is a character you use to group keys.
@!attribute [rw] delimiter
@return [String]<br>: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html<br>[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html<br><br><br><br>Outposts][2] in the *Amazon S3 User Guide*.
more information about S3 on Outposts ARNs, see [Using S3 on
you provide the Outposts bucket ARN in place of the bucket name. For
When using this action using S3 on Outposts through the AWS SDKs,
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
takes the form
requests to the S3 on Outposts hostname. The S3 on Outposts hostname
When using this action with Amazon S3 on Outposts, you must direct<br><br>points] in the *Amazon S3 User Guide*.
more information about access point ARNs, see [Using access
you provide the access point ARN in place of the bucket name. For
When using this action with an access point through the AWS SDKs,
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
takes the form
requests to the access point hostname. The access point hostname
When using this action with an access point, you must direct
The name of the bucket containing the objects.
@!attribute [rw] bucket
}
expected_bucket_owner: “AccountId”,
request_payer: “requester”, # accepts requester
prefix: “Prefix”,
max_keys: 1,
marker: “Marker”,
encoding_type: “url”, # accepts url
delimiter: “Delimiter”,
bucket: “BucketName”, # required
{
data as a hash:
@note When making an API call, you may pass ListObjectsRequest