class Aws::S3::Types::ListObjectsV2Request
@note When making an API call, you may pass ListObjectsV2Request
data as a hash: { bucket: "BucketName", # required delimiter: "Delimiter", encoding_type: "url", # accepts url max_keys: 1, prefix: "Prefix", continuation_token: "Token", fetch_owner: false, start_after: "StartAfter", request_payer: "requester", # accepts requester expected_bucket_owner: "AccountId", }
@!attribute [rw] bucket
Bucket name to list. 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
Encoding type used by Amazon S3 to encode object keys in the response. @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] continuation_token
ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. @return [String]
@!attribute [rw] fetch_owner
The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true. @return [Boolean]
@!attribute [rw] start_after
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket. @return [String]
@!attribute [rw] request_payer
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. 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/ListObjectsV2Request AWS API Documentation
Constants
- SENSITIVE