ListMultipartUploads
This action 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 action 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 and Permissions.
The following operations are related to ListMultipartUploads
:
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: Bucket
.s3.amazonaws.com
x-amz-expected-bucket-owner: ExpectedBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
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 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 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 AWS 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.Required: Yes
- delimiter
-
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 underCommonPrefixes
result element are not returned elsewhere in the response. - encoding-type
-
Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, 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.
Valid Values:
url
- key-marker
-
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 specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
. - max-uploads
-
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.
- prefix
-
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.)
- upload-id-marker
-
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
. - x-amz-expected-bucket-owner
-
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).
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListMultipartUploadsResult>
<Bucket>string</Bucket>
<KeyMarker>string</KeyMarker>
<UploadIdMarker>string</UploadIdMarker>
<NextKeyMarker>string</NextKeyMarker>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<NextUploadIdMarker>string</NextUploadIdMarker>
<MaxUploads>integer</MaxUploads>
<IsTruncated>boolean</IsTruncated>
<Upload>
<ChecksumAlgorithm>string</ChecksumAlgorithm>
<Initiated>timestamp</Initiated>
<Initiator>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Initiator>
<Key>string</Key>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<StorageClass>string</StorageClass>
<UploadId>string</UploadId>
</Upload>
...
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
</ListMultipartUploadsResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListMultipartUploadsResult
-
Root level tag for the ListMultipartUploadsResult parameters.
Required: Yes
- Bucket
-
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
Type: 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 thePrefix
child element.Type: Array of CommonPrefix data types
- Delimiter
-
Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
Type: String
- EncodingType
-
Encoding type used by Amazon S3 to encode object keys in the response.
If you specify
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter
,KeyMarker
,Prefix
,NextKeyMarker
,Key
.Type: String
Valid Values:
url
- IsTruncated
-
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
Type: Boolean
- KeyMarker
-
The key at or after which the listing began.
Type: String
- MaxUploads
-
Maximum number of multipart uploads that could have been included in the response.
Type: Integer
- 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.
Type: 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.Type: String
- Prefix
-
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
Type: String
- Upload
-
Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.Type: Array of MultipartUpload data types
- UploadIdMarker
-
Upload ID after which listing began.
Type: String
Examples
Sample Request
The following request lists three multipart uploads. The request specifies the
max-uploads
request parameter to set the maximum number of multipart
uploads to return in the response body.
GET /?uploads&max-uploads=3 HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Mon, 1 Nov 2010 20:34:56 GMT Authorization: authorization string
Sample Response
The following sample response indicates that the multipart upload list was
truncated and provides the NextKeyMarker
and the
NextUploadIdMarker
elements. You specify these values in your
subsequent requests to read the next set of multipart uploads. That is, send a
subsequent request specifying key-marker=my-movie2.m2ts
(value of the
NextKeyMarker
element) and
upload-id-marker=YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ
(value of the NextUploadIdMarker
).
The sample response also shows a case of two multipart uploads in progress with
the same key (my-movie.m2ts
). That is, the response shows two uploads
with the same key. This response shows the uploads sorted by key, and within each key
the uploads are sorted in ascending order by the time the multipart upload was
initiated.
HTTP/1.1 200 OK x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 Date: Mon, 1 Nov 2010 20:34:56 GMT Content-Length: 1330 Connection: keep-alive Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Bucket>bucket</Bucket> <KeyMarker></KeyMarker> <UploadIdMarker></UploadIdMarker> <NextKeyMarker>my-movie.m2ts</NextKeyMarker> <NextUploadIdMarker>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</NextUploadIdMarker> <MaxUploads>3</MaxUploads> <IsTruncated>true</IsTruncated> <Upload> <Key>my-divisor</Key> <UploadId>XMgbGlrZSBlbHZpbmcncyBub3QgaGF2aW5nIG11Y2ggbHVjaw</UploadId> <Initiator> <ID>arn:aws:iam::111122223333:user/user1-11111a31-17b5-4fb7-9df5-b111111f13de</ID> <DisplayName>user1-11111a31-17b5-4fb7-9df5-b111111f13de</DisplayName> </Initiator> <Owner> <ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID> <DisplayName>OwnerDisplayName</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> <Initiated>2010-11-10T20:48:33.000Z</Initiated> </Upload> <Upload> <Key>my-movie.m2ts</Key> <UploadId>VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId> <Initiator> <ID>b1d16700c70b0b05597d7acd6a3f92be</ID> <DisplayName>InitiatorDisplayName</DisplayName> </Initiator> <Owner> <ID>b1d16700c70b0b05597d7acd6a3f92be</ID> <DisplayName>OwnerDisplayName</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> <Initiated>2010-11-10T20:48:33.000Z</Initiated> </Upload> <Upload> <Key>my-movie.m2ts</Key> <UploadId>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</UploadId> <Initiator> <ID>arn:aws:iam::444455556666:user/user1-22222a31-17b5-4fb7-9df5-b222222f13de</ID> <DisplayName>user1-22222a31-17b5-4fb7-9df5-b222222f13de</DisplayName> </Initiator> <Owner> <ID>b1d16700c70b0b05597d7acd6a3f92be</ID> <DisplayName>OwnerDisplayName</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> <Initiated>2010-11-10T20:49:33.000Z</Initiated> </Upload> </ListMultipartUploadsResult>
Sample Request: Using the delimiter and the prefix parameters
Assume you have a multipart upload in progress for the following keys in your
bucket, example-bucket
.
-
photos/2006/January/sample.jpg
-
photos/2006/February/sample.jpg
-
photos/2006/March/sample.jpg
-
videos/2006/March/sample.wmv
-
sample.jpg
The following list multipart upload request specifies the delimiter parameter with value "/".
GET /?uploads&delimiter=/ HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Mon, 1 Nov 2010 20:34:56 GMT Authorization: authorization string
Sample Response
The following sample response lists multipart uploads on the specified bucket,
example-bucket
.
The response returns multipart upload for the sample.jpg
key in an
<Upload>
element.
However, because all the other keys contain the specified delimiter, a distinct
substring, from the beginning of the key to the first occurrence of the delimiter,
from each of these keys is returned in a <CommonPrefixes> element. The key
substrings, photos/
and videos/
in the
<CommonPrefixes> element, indicate that there are one or more in-progress
multipart uploads with these key prefixes.
This is a useful scenario if you use key prefixes for your objects to create a
logical folder like structure. In this case, you can interpret the result as the
folders photos/
and videos/
have one or more multipart
uploads in progress.
<ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Bucket>example-bucket</Bucket> <KeyMarker/> <UploadIdMarker/> <NextKeyMarker>sample.jpg</NextKeyMarker> <NextUploadIdMarker>Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</NextUploadIdMarker> <Delimiter>/</Delimiter> <Prefix/> <MaxUploads>1000</MaxUploads> <IsTruncated>false</IsTruncated> <Upload> <Key>sample.jpg</Key> <UploadId>Agw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1N99trdp4tpO88.PT6.MhO0w2E17eutfAvQfQWoajgE_W2gpcxQw--</UploadId> <Initiator> <ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID> <DisplayName>string</DisplayName> </Initiator> <Owner> <ID>314133b66967d86f031c7249d1d9a80249109428335cd0ef1cdc487b4566cb1b</ID> <DisplayName>string</DisplayName> </Owner> <StorageClass>STANDARD</StorageClass> <Initiated>2010-11-26T19:24:17.000Z</Initiated> </Upload> <CommonPrefixes> <Prefix>photos/</Prefix> </CommonPrefixes> <CommonPrefixes> <Prefix>videos/</Prefix> </CommonPrefixes> </ListMultipartUploadsResult>
Sample Request
In addition to the delimiter parameter, you can filter results by adding a prefix parameter as shown in the following request.
GET /?uploads&delimiter=/&prefix=photos/2006/ HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Mon, 1 Nov 2010 20:34:56 GMT Authorization: authorization string
Sample Response
In this case, the response will include only multipart uploads for keys that start with the specified prefix. The value returned in the <CommonPrefixes> element is a substring from the beginning of the key to the first occurrence of the specified delimiter after the prefix.
<?xml version="1.0" encoding="UTF-8"?> <ListMultipartUploadsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Bucket>example-bucket</Bucket> <KeyMarker/> <UploadIdMarker/> <NextKeyMarker/> <NextUploadIdMarker/> <Delimiter>/</Delimiter> <Prefix>photos/2006/</Prefix> <MaxUploads>1000</MaxUploads> <IsTruncated>false</IsTruncated> <CommonPrefixes> <Prefix>photos/2006/February/</Prefix> </CommonPrefixes> <CommonPrefixes> <Prefix>photos/2006/January/</Prefix> </CommonPrefixes> <CommonPrefixes> <Prefix>photos/2006/March/</Prefix> </CommonPrefixes> </ListMultipartUploadsResult>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: