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 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
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
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 using 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.
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 under CommonPrefixes 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 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.
- 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.
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> <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
-
Name of the bucket to which the multipart upload was initiated.
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 the Prefix 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