UNPKG

@aws-sdk/client-s3

Version:

AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native

64 lines (63 loc) 3.73 kB
import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { ListPartsOutput, ListPartsRequest } from "../models/models_0"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer } from "@aws-sdk/types"; export declare type ListPartsCommandInput = ListPartsRequest; export declare type ListPartsCommandOutput = ListPartsOutput & __MetadataBearer; /** * <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>). * 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 * <code>max-parts</code> request parameter. If your multipart upload consists of more than * 1,000 parts, the response returns an <code>IsTruncated</code> field with the value of true, * and a <code>NextPartNumberMarker</code> element. In subsequent <code>ListParts</code> * requests you can include the part-number-marker query string parameter and set its value to * the <code>NextPartNumberMarker</code> field value from the previous response.</p> * * <p>For more information on multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart * Upload</a>.</p> * * <p>For information on permissions required to use the multipart upload API, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart Upload API and * Permissions</a>.</p> * * <p>The following operations are related to <code>ListParts</code>:</p> * <ul> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> * </p> * </li> * </ul> */ export declare class ListPartsCommand extends $Command<ListPartsCommandInput, ListPartsCommandOutput, S3ClientResolvedConfig> { readonly input: ListPartsCommandInput; constructor(input: ListPartsCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListPartsCommandInput, ListPartsCommandOutput>; private serialize; private deserialize; }