@aws-sdk/client-s3

/// <reference types="node" /> 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 { UploadPartOutput, UploadPartRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link UploadPartCommand}. */ export type UploadPartCommandInputType = Omit<UploadPartRequest, "Body"> & { /** * For *`UploadPartRequest["Body"]`*, see {@link UploadPartRequest.Body}. */ Body?: UploadPartRequest["Body"] | string | Uint8Array | Buffer; }; /** * This interface extends from `UploadPartRequest` interface. There are more parameters than `Body` defined in {@link UploadPartRequest} */ export interface UploadPartCommandInput extends UploadPartCommandInputType { } /** * @public * * The output of {@link UploadPartCommand}. */ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBearer { } /** * @public * Uploads a part in a multipart upload. * <note> * In this operation, you provide part data in your request. However, you have an option * to specify your existing Amazon S3 object as a data source for the part you are uploading. To * upload a part from an existing object, you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html">UploadPartCopy</a> operation. * * </note> * You must initiate a multipart upload (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>) * before you can upload any part. In response to your initiate request, Amazon S3 returns an * upload ID, a unique identifier, that you must include in your upload part request. * Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely * identifies a part and also defines its position within the object being created. If you * upload a new part using the same part number that was used with a previous part, the * previously uploaded part is overwritten. * For information about maximum and minimum part sizes and other multipart upload * specifications, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/qfacts.html">Multipart upload limits</a> in the Amazon S3 User Guide. * To ensure that data is not corrupted when traversing the network, specify the * <code>Content-MD5</code> header in the upload part request. Amazon S3 checks the part data * against the provided MD5 value. If they do not match, Amazon S3 returns an error. * If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the * <code>x-amz-content-sha256</code> header as a checksum instead of * <code>Content-MD5</code>. For more information see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html">Authenticating * Requests: Using the Authorization Header (Amazon Web Services Signature Version 4)</a>. * * Note: After you initiate multipart upload and upload * one or more parts, you must either complete or abort multipart upload in order to stop * getting charged for storage of the uploaded parts. Only after you either complete or abort * multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts * storage. * For more information on multipart uploads, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html">Multipart Upload Overview</a> in the * Amazon S3 User Guide . * For information on the permissions required to use the multipart upload API, go to * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html">Multipart * Upload and Permissions</a> in the Amazon S3 User Guide. * Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it * writes it to disks in its data centers and decrypts it when you access it. You have three * mutually exclusive options to protect data using server-side encryption in Amazon S3, depending * on how you choose to manage the encryption keys. Specifically, the encryption key options * are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys * (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by * default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption * with other key options. The option you use depends on whether you want to use KMS keys * (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own * encryption key, the request headers you provide in the request must match the headers you * used in the request to initiate the upload by using <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. * For more information, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side * Encryption</a> in the Amazon S3 User Guide. * Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are * using a customer-provided encryption key (SSE-C), you don't need to specify the encryption * parameters in each UploadPart request. Instead, you only need to specify the server-side * encryption parameters in the initial Initiate Multipart request. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a>. * If you requested server-side encryption using a customer-provided encryption key (SSE-C) * in your initiate multipart upload request, you must provide identical encryption * information in each part upload using the following headers. * <ul> * <li> * x-amz-server-side-encryption-customer-algorithm * </li> * <li> * x-amz-server-side-encryption-customer-key * </li> * <li> * x-amz-server-side-encryption-customer-key-MD5 * </li> * </ul> * * <code>UploadPart</code> has the following special errors: * <ul> * <li> * <ul> * <li> * * Code: NoSuchUpload * * </li> * <li> * * Cause: The specified multipart upload does not exist. The upload * ID might be invalid, or the multipart upload might have been aborted or * completed. * * </li> * <li> * * HTTP Status Code: 404 Not Found * * </li> * <li> * * SOAP Fault Code Prefix: Client * * </li> * </ul> * </li> * </ul> * The following operations are related to <code>UploadPart</code>: * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html">CreateMultipartUpload</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html">CompleteMultipartUpload</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html">AbortMultipartUpload</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html">ListParts</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a> * * </li> * </ul> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, UploadPartCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, UploadPartCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // UploadPartRequest * Body: "STREAMING_BLOB_VALUE", * Bucket: "STRING_VALUE", // required * ContentLength: Number("long"), * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256", * ChecksumCRC32: "STRING_VALUE", * ChecksumCRC32C: "STRING_VALUE", * ChecksumSHA1: "STRING_VALUE", * ChecksumSHA256: "STRING_VALUE", * Key: "STRING_VALUE", // required * PartNumber: Number("int"), // required * UploadId: "STRING_VALUE", // required * SSECustomerAlgorithm: "STRING_VALUE", * SSECustomerKey: "STRING_VALUE", * SSECustomerKeyMD5: "STRING_VALUE", * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new UploadPartCommand(input); * const response = await client.send(command); * // { // UploadPartOutput * // ServerSideEncryption: "AES256" || "aws:kms", * // ETag: "STRING_VALUE", * // ChecksumCRC32: "STRING_VALUE", * // ChecksumCRC32C: "STRING_VALUE", * // ChecksumSHA1: "STRING_VALUE", * // ChecksumSHA256: "STRING_VALUE", * // SSECustomerAlgorithm: "STRING_VALUE", * // SSECustomerKeyMD5: "STRING_VALUE", * // SSEKMSKeyId: "STRING_VALUE", * // BucketKeyEnabled: true || false, * // RequestCharged: "requester", * // }; * * ``` * * @param UploadPartCommandInput - {@link UploadPartCommandInput} * @returns {@link UploadPartCommandOutput} * @see {@link UploadPartCommandInput} for command's `input` shape. * @see {@link UploadPartCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} * Base exception class for all service exceptions from S3 service. * * @example To upload a part * ```javascript * // The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload. * const input = { * "Body": "fileToUpload", * "Bucket": "examplebucket", * "Key": "examplelargeobject", * "PartNumber": "1", * "UploadId": "xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" * }; * const command = new UploadPartCommand(input); * const response = await client.send(command); * /* response == * { * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"" * } * *\/ * // example id: to-upload-a-part-1481847914943 * ``` * */ export declare class UploadPartCommand extends $Command<UploadPartCommandInput, UploadPartCommandOutput, S3ClientResolvedConfig> { readonly input: UploadPartCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; /** * @public */ constructor(input: UploadPartCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UploadPartCommandInput, UploadPartCommandOutput>; /** * @internal */ private serialize; /** * @internal */ private deserialize; }