ListParts
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.
Request Syntax
URI Request Parameters
The request uses the following URI parameters.
Bucket
The name of the bucket to which the parts are being uploaded.
Required: Yes
Key
Object key for which the multipart upload was initiated.
Length Constraints: Minimum length of 1.
Required: Yes
max-parts
Sets the maximum number of parts to return.
part-number-marker
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
uploadId
Upload ID identifying the multipart upload whose parts are being listed.
Required: Yes
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).
x-amz-request-payer
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests.
Valid Values: requester
x-amz-server-side-encryption-customer-algorithm
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm.
x-amz-server-side-encryption-customer-key
Not supported at the moment.
x-amz-server-side-encryption-customer-key-MD5
Not supported at the moment.
Request Body
The request does not have a request body.
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
x-amz-abort-date
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation.
The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.
x-amz-abort-rule-id
This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
x-amz-request-charged
If present, indicates that the requester was successfully charged for the request.
Valid Values: requester
The following data is returned in XML format by the service.
ListPartsResult
Root level tag for the ListPartsResult 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
Initiator
Container element that identifies who initiated the multipart upload. If the initiator is an Petabox account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.
Type: Initiator data type
IsTruncated
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
Type: Boolean
Key
Object key for which the multipart upload was initiated.
Type: String
Length Constraints: Minimum length of 1.
MaxParts
Maximum number of parts that were allowed in the response.
Type: Integer
NextPartNumberMarker
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
Type: Integer
Owner
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
Type: Owner data type
Part
Container for elements related to a particular part. A response can contain zero or more Part elements.
Type: Array of Part data types
PartNumberMarker
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
Type: Integer
StorageClass
Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
Type: String
Valid Values: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR
UploadId
Upload ID identifying the multipart upload whose parts are being listed.
Type: String
Examples
Sample Request
Assume you have uploaded parts with sequential part numbers starting with 1. The following List Parts request specifies max-parts and part-number-marker query parameters. The request lists the first two parts that follow part number 1, that is, you will get parts 2 and 3 in the response. If more parts exist, the result is a truncated result and therefore the response will return an IsTruncated element with the value true. The response will also return the NextPartNumberMarker element with the value 3, which should be used for the value of the part-number-marker request query string parameter in the next ListParts request.
Sample Response
This example illustrates one usage of ListParts.
Last updated