We are excited to announce our new API Documentation.
Optional
DelimiterCharacter you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first
occurrence of the delimiter after the prefix are grouped under a single result element,
CommonPrefixes
. If you don't specify the prefix parameter, then the
substring starts at the beginning of the key. The keys that are grouped under
CommonPrefixes
result element are not returned elsewhere in the
response.
Optional
EncodingRequests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the 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.
Optional
ExpectedThe 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).
Optional
KeyTogether with upload-id-marker
, this parameter specifies the multipart
upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically
greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to
the key-marker
might also be included, provided those multipart uploads have
upload IDs lexicographically greater than the specified
upload-id-marker
.
Optional
MaxSets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
Optional
PrefixLists in-progress uploads only for those keys that begin with the specified prefix. You
can use prefixes to separate a bucket into different grouping of keys. (You can think of
using prefix
to make groups in the same way that you'd use a folder in a file
system.)
Optional
RequestConfirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Optional
UploadTogether with key-marker, specifies the multipart upload after which listing should
begin. If key-marker is not specified, the upload-id-marker parameter is ignored.
Otherwise, any multipart uploads for a key equal to the key-marker might be included in the
list only if they have an upload ID lexicographically greater than the specified
upload-id-marker
.
The name of the bucket to which the multipart upload was initiated.
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.Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues