Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide.
See https://www.paws-r-sdk.com/docs/s3_list_objects_v2/ for full documentation.
s3_list_objects_v2(
Bucket,
Delimiter = NULL,
EncodingType = NULL,
MaxKeys = NULL,
Prefix = NULL,
ContinuationToken = NULL,
FetchOwner = NULL,
StartAfter = NULL,
RequestPayer = NULL,
ExpectedBucketOwner = NULL,
OptionalObjectAttributes = NULL
)[required] 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 in the Amazon S3 User Guide.
When you use 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 you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of the
bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts?
in the Amazon S3 User Guide.
A delimiter is a character that you use to group keys.
Encoding type used by Amazon S3 to encode object keys in the response.
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.
Limits the response to keys that begin with the specified prefix.
ContinuationToken indicates to Amazon S3 that the list is being
continued on this bucket with a token. ContinuationToken is obfuscated
and is not a real key.
The owner field is not present in
list_objects_v2 by default. If you want to
return the owner field with each key in the result, then set the
FetchOwner field to true.
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.
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.
The account ID of the expected bucket owner. If the bucket is owned by a
different account, the request fails with the HTTP status code
403 Forbidden (access denied).
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.