This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response.
1,000 multipart uploads is the maximum number of uploads a response can
include, which is also the default value. You can further limit the
number of uploads in a response by specifying the max-uploads
parameter in the response. If additional multipart uploads satisfy the
list criteria, the response will contain an IsTruncated
element with
the value true. To list the additional multipart uploads, use the
key-marker
and upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to
list_multipart_uploads
:
create_multipart_upload
upload_part
complete_multipart_upload
list_parts
abort_multipart_upload
s3_list_multipart_uploads(Bucket, Delimiter, EncodingType, KeyMarker,
MaxUploads, Prefix, UploadIdMarker, ExpectedBucketOwner)
A list with the following syntax:
list(
Bucket = "string",
KeyMarker = "string",
UploadIdMarker = "string",
NextKeyMarker = "string",
Prefix = "string",
Delimiter = "string",
NextUploadIdMarker = "string",
MaxUploads = 123,
IsTruncated = TRUE|FALSE,
Uploads = list(
list(
UploadId = "string",
Key = "string",
Initiated = as.POSIXct(
"2015-01-01"
),
StorageClass = "STANDARD"|"REDUCED_REDUNDANCY"|"STANDARD_IA"|"ONEZONE_IA"|"INTELLIGENT_TIERING"|"GLACIER"|"DEEP_ARCHIVE"|"OUTPOSTS",
Owner = list(
DisplayName = "string",
ID = "string"
),
Initiator = list(
ID = "string",
DisplayName = "string"
)
)
),
CommonPrefixes = list(
list(
Prefix = "string"
)
),
EncodingType = "url"
)
[required] The name of the bucket to which the multipart upload was initiated.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 operation using S3 on Outposts through the AWS 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 in the Amazon Simple Storage Service Developer Guide.
Character 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.
Together 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
.
Sets 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.
Lists 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 you'd use a folder in a file system.)
Together 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 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.
svc$list_multipart_uploads(
Bucket = "string",
Delimiter = "string",
EncodingType = "url",
KeyMarker = "string",
MaxUploads = 123,
Prefix = "string",
UploadIdMarker = "string",
ExpectedBucketOwner = "string"
)
if (FALSE) {
# The following example specifies the upload-id-marker and key-marker from
# previous truncated response to retrieve next setup of multipart uploads.
svc$list_multipart_uploads(
Bucket = "examplebucket",
KeyMarker = "nextkeyfrompreviousresponse",
MaxUploads = "2",
UploadIdMarker = "valuefrompreviousresponse"
)
# The following example lists in-progress multipart uploads on a specific
# bucket.
svc$list_multipart_uploads(
Bucket = "examplebucket"
)
}
Run the code above in your browser using DataLab