ListMultipartUploads
Lists in-progress multipart uploads in a bucket.
Description
The ListMultipartUploads operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated using the CreateMultipartUpload request, but has not yet been completed or aborted.
Important
- This operation returns at most 1,000 multipart uploads in the response. This is also the default value.
- The response might contain fewer uploads than specified by max-uploads.
- Always check the
IsTruncatedelement in the response. - If there are additional multipart uploads to list, the response will include a
NextKeyMarkerandNextUploadIdMarkerthat can be used in subsequent requests.
Request Syntax
GET /?uploads&delimiter=Delimiter&encoding-type=EncodingType&key-marker=KeyMarker&max-uploads=MaxUploads&prefix=Prefix&upload-id-marker=UploadIdMarker HTTP/1.1
Host: BucketName.qstorage.quilibrium.com
x-amz-expected-bucket-owner: OwnerAccountId
Values in italics indicate user input and should be replaced with actual values.
This operation does not have a request body.
Request Parameters
URI Parameters
| Name | Description | Required | Type |
|---|---|---|---|
| delimiter | A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes | No | text |
| encoding-type | Specifies the encoding method to use for object key names in the response | No | text |
| key-marker | Together with upload-id-marker, specifies the multipart upload after which listing should begin | No | text |
| max-uploads | Sets the maximum number of multipart uploads to return in the response body (default: 1000) | No | number |
| prefix | Limits the response to keys that begin with the specified prefix | No | text |
| upload-id-marker | Together with key-marker, specifies the multipart upload after which listing should begin | No | text |
Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-expected-bucket-owner | The account ID of the expected bucket owner | No | text |
Response Syntax
HTTP/1.1 200 OK
x-amz-id-2: RequestId
x-amz-request-id: AmazonRequestId
Date: ISO8601Date
<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult>
<Bucket>BucketName</Bucket>
<KeyMarker>KeyMarker</KeyMarker>
<UploadIdMarker>UploadIdMarker</UploadIdMarker>
<NextKeyMarker>NextKeyMarker</NextKeyMarker>
<NextUploadIdMarker>NextUploadIdMarker</NextUploadIdMarker>
<Delimiter>Delimiter</Delimiter>
<Prefix>Prefix</Prefix>
<MaxUploads>MaxUploads</MaxUploads>
<IsTruncated>true|false</IsTruncated>
<Upload>
<Key>ObjectKey</Key>
<UploadId>UploadId</UploadId>
<Initiator>
<ID>InitiatorId</ID>
<DisplayName>InitiatorName</DisplayName>
</Initiator>
<Owner>
<ID>OwnerId</ID>
<DisplayName>OwnerName</DisplayName>
</Owner>
<Initiated>ISO8601Date</Initiated>
</Upload>
<CommonPrefixes>
<Prefix>CommonPrefix</Prefix>
</CommonPrefixes>
</ListMultipartUploadsResult>
Values in italics indicate variable response values.
Response Elements
Response Headers
| Name | Description | Required | Type |
|---|---|---|---|
| x-amz-id-2 | An identifier for the request | No | String |
| x-amz-request-id | A unique identifier for the request | No | String |
| Date | The date and time at which the response was sent | No | String |
Response Body Elements
| Name | Description | Required | Type |
|---|---|---|---|
| ListMultipartUploadsResult | Container for the response | No | String |
| Bucket | Name of the bucket to which the multipart upload was initiated | No | String |
| KeyMarker | The key at which the listing begins | No | String |
| UploadIdMarker | Upload ID after which listing begins | No | String |
| NextKeyMarker | When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request | No | String |
| NextUploadIdMarker | When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request | No | String |
| MaxUploads | Maximum number of multipart uploads that could have been returned | No | String |
| IsTruncated | Indicates whether the returned list of multipart uploads is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads | No | String |
| Upload | Container for elements related to a particular multipart upload | No | String |
| Key | Key of the object for which the multipart upload was initiated | No | String |
| UploadId | Upload ID that identifies the multipart upload | No | String |
| Initiator | Identifies who initiated the multipart upload | No | String |
| Owner | Identifies the object owner | No | String |
| Initiated | Date and time at which the multipart upload was initiated | No | String |
| CommonPrefixes | If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element | No | String |
| Prefix | Keys that begin with the indicated prefix | No | String |
Special Errors
| Error Code | Description |
|---|---|
| NoSuchBucket | The specified bucket does not exist |
| 403 | Forbidden. Authentication failed or you do not have permission to list multipart uploads |
Permissions
You must have the s3:ListBucketMultipartUploads permission on the bucket.
Related Operations
The following operations are related to ListMultipartUploads:
- CreateMultipartUpload
- UploadPart
- CompleteMultipartUpload
- ListParts
- AbortMultipartUpload
Examples
Example 1: List all multipart uploads
GET /?uploads HTTP/1.1
Host: my-bucket.qstorage.quilibrium.com
Values in italics indicate user input and should be replaced with actual values.
HTTP/1.1 200 OK
x-amz-id-2: Example7qoYGN7uMuFuYS6m7a4l
x-amz-request-id: TX234S0F24A06C7
Date: Wed, 01 Mar 2024 12:00:00 GMT
<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult>
<Bucket>my-bucket</Bucket>
<KeyMarker></KeyMarker>
<UploadIdMarker></UploadIdMarker>
<NextKeyMarker>large-file.zip</NextKeyMarker>
<NextUploadIdMarker>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</NextUploadIdMarker>
<MaxUploads>1000</MaxUploads>
<IsTruncated>false</IsTruncated>
<Upload>
<Key>large-file.zip</Key>
<UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>
<Initiator>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Initiator>
<Owner>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Owner>
<Initiated>2024-03-01T11:30:00.000Z</Initiated>
</Upload>
</ListMultipartUploadsResult>
Values in italics indicate variable response values.
Example 2: List multipart uploads with a prefix
GET /?uploads&prefix=documents/&max-uploads=2 HTTP/1.1
Host: my-bucket.qstorage.quilibrium.com
Values in italics indicate user input and should be replaced with actual values.
HTTP/1.1 200 OK
x-amz-id-2: Example7qoYGN7uMuFuYS6m7a4l
x-amz-request-id: TX234S0F24A06C7
Date: Wed, 01 Mar 2024 12:00:00 GMT
<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult>
<Bucket>my-bucket</Bucket>
<KeyMarker></KeyMarker>
<UploadIdMarker></UploadIdMarker>
<Prefix>documents/</Prefix>
<MaxUploads>2</MaxUploads>
<IsTruncated>true</IsTruncated>
<NextKeyMarker>documents/report.pdf</NextKeyMarker>
<NextUploadIdMarker>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</NextUploadIdMarker>
<Upload>
<Key>documents/presentation.pptx</Key>
<UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>
<Initiator>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Initiator>
<Owner>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Owner>
<Initiated>2024-03-01T11:30:00.000Z</Initiated>
</Upload>
<Upload>
<Key>documents/report.pdf</Key>
<UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>
<Initiator>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Initiator>
<Owner>
<ID>123456789012</ID>
<DisplayName>user@example.com</DisplayName>
</Owner>
<Initiated>2024-03-01T11:45:00.000Z</Initiated>
</Upload>
</ListMultipartUploadsResult>
Values in italics indicate variable response values.
Try It Out
Test ListMultipartUploads
List in-progress multipart uploads in a bucket.
Coming Soon
This feature is currently under development and will be available soon.