import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { ListPartsOutput, ListPartsRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link ListPartsCommand}. */ export interface ListPartsCommandInput extends ListPartsRequest { } /** * @public * * The output of {@link ListPartsCommand}. */ export interface ListPartsCommandOutput extends ListPartsOutput, __MetadataBearer { } /** * @public *

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.

*

If the upload was created using a checksum algorithm, you will need to have permission * to the kms:Decrypt action for the request to succeed. *

*

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 ListParts:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, ListPartsCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, ListPartsCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // ListPartsRequest * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * MaxParts: Number("int"), * PartNumberMarker: "STRING_VALUE", * UploadId: "STRING_VALUE", // required * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", * SSECustomerAlgorithm: "STRING_VALUE", * SSECustomerKey: "STRING_VALUE", * SSECustomerKeyMD5: "STRING_VALUE", * }; * const command = new ListPartsCommand(input); * const response = await client.send(command); * ``` * * @param ListPartsCommandInput - {@link ListPartsCommandInput} * @returns {@link ListPartsCommandOutput} * @see {@link ListPartsCommandInput} for command's `input` shape. * @see {@link ListPartsCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * * @example To list parts of a multipart upload. * ```javascript * // The following example lists parts uploaded for a specific multipart upload. * const input = { * "Bucket": "examplebucket", * "Key": "bigobject", * "UploadId": "example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" * }; * const command = new ListPartsCommand(input); * const response = await client.send(command); * /* response == * { * "Initiator": { * "DisplayName": "owner-display-name", * "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" * }, * "Owner": { * "DisplayName": "owner-display-name", * "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc" * }, * "Parts": [ * { * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", * "LastModified": "2016-12-16T00:11:42.000Z", * "PartNumber": "1", * "Size": 26246026 * }, * { * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", * "LastModified": "2016-12-16T00:15:01.000Z", * "PartNumber": "2", * "Size": 26246026 * } * ], * "StorageClass": "STANDARD" * } * *\/ * // example id: to-list-parts-of-a-multipart-upload-1481852006923 * ``` * */ export declare class ListPartsCommand extends $Command { readonly input: ListPartsCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; /** * @public */ constructor(input: ListPartsCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler; /** * @internal */ private serialize; /** * @internal */ private deserialize; }