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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see list_buckets.
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] Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests
are not supported. Directory bucket names must be unique in the chosen
Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3 (for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket
naming restrictions, see Directory bucket naming rules
in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
Directory buckets - For directory buckets, / is the only
supported delimiter.
Directory buckets - When you query
list_objects_v2 with a delimiter during
in-progress multipart uploads, the CommonPrefixes response
parameter contains the prefixes that are associated with the
in-progress multipart uploads. For more information about multipart
uploads, see Multipart Upload Overview
in the Amazon S3 User Guide.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in
an object's key name will be percent-encoded according to UTF-8 code
values. For example, the object test_file(3).png will appear as
test_file%283%29.png.
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.
Directory buckets - For directory buckets, only prefixes that end in
a delimiter (/) are supported.
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. You can use this ContinuationToken for
pagination of the list results.
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.
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, 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.
This functionality is not supported for directory buckets.