@aws-sdk/client-s3

import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { UploadPartCopyOutput, UploadPartCopyRequest } from "../models/models_1"; import { deserializeAws_restXmlUploadPartCopyCommand, serializeAws_restXmlUploadPartCopyCommand, } from "../protocols/Aws_restXml"; import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint"; import { getThrow200ExceptionsPlugin } from "@aws-sdk/middleware-sdk-s3"; import { getSerdePlugin } from "@aws-sdk/middleware-serde"; import { getSsecPlugin } from "@aws-sdk/middleware-ssec"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { FinalizeHandlerArguments, Handler, HandlerExecutionContext, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, SerdeContext as __SerdeContext, } from "@aws-sdk/types"; export type UploadPartCopyCommandInput = UploadPartCopyRequest; export type UploadPartCopyCommandOutput = UploadPartCopyOutput & __MetadataBearer; /** * Uploads a part by copying data from an existing object as data source. You specify the * data source by adding the request header <code>x-amz-copy-source</code> in your request and * a byte range by adding the request header <code>x-amz-copy-source-range</code> in your * request. * The minimum allowable part size for a multipart upload is 5 MB. For more information * about multipart upload limits, go to <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html">Quick * Facts</a> in the Amazon Simple Storage Service Developer Guide. * <note> * Instead of using an existing object as part data, you might use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a> * operation and provide data in your request. * </note> * * You must initiate a multipart upload before you can upload any part. In response to your * initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in * your upload part request. * For more information about using the <code>UploadPartCopy</code> operation, see the * following: * * <ul> * <li> * For conceptual information about multipart uploads, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html">Uploading Objects Using Multipart * Upload</a> in the Amazon Simple Storage Service Developer Guide. * </li> * <li> * For information about 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> in the Amazon Simple Storage Service Developer Guide. * </li> * <li> * For information about copying objects using a single atomic operation vs. the * multipart upload, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html">Operations on * Objects</a> in the Amazon Simple Storage Service Developer Guide. * </li> * <li> * For information about using server-side encryption with customer-provided * encryption keys with the UploadPartCopy operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html">UploadPart</a>. * </li> * </ul> * Note the following additional considerations about the request headers * <code>x-amz-copy-source-if-match</code>, <code>x-amz-copy-source-if-none-match</code>, * <code>x-amz-copy-source-if-unmodified-since</code>, and * <code>x-amz-copy-source-if-modified-since</code>: * * <ul> * <li> * * Consideration 1 - If both of the * <code>x-amz-copy-source-if-match</code> and * <code>x-amz-copy-source-if-unmodified-since</code> headers are present in the * request as follows: * * <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>, * and; * * <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to * <code>false</code>; * Amazon S3 returns <code>200 OK</code> and copies the data. * * * </li> * <li> * * Consideration 2 - If both of the * <code>x-amz-copy-source-if-none-match</code> and * <code>x-amz-copy-source-if-modified-since</code> headers are present in the * request as follows: * * <code>x-amz-copy-source-if-none-match</code> condition evaluates to * <code>false</code>, and; * * <code>x-amz-copy-source-if-modified-since</code> condition evaluates to * <code>true</code>; * Amazon S3 returns <code>412 Precondition Failed</code> response code. * * </li> * </ul> * * Versioning * * If your bucket has versioning enabled, you could have multiple versions of the same * object. By default, <code>x-amz-copy-source</code> identifies the current version of the * object to copy. If the current version is a delete marker and you don't specify a versionId * in the <code>x-amz-copy-source</code>, Amazon S3 returns a 404 error, because the object does * not exist. If you specify versionId in the <code>x-amz-copy-source</code> and the versionId * is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify * a delete marker as a version for the <code>x-amz-copy-source</code>. * You can optionally specify a specific version of the source object to copy by adding the * <code>versionId</code> subresource as shown in the following example: * * <code>x-amz-copy-source: /bucket/object?versionId=version id</code> * * * * 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> * </ul> * </li> * <li> * <ul> * <li> * * Code: InvalidRequest * * </li> * <li> * * Cause: The specified copy source is not supported as a byte-range * copy source. * * </li> * <li> * * HTTP Status Code: 400 Bad Request * * </li> * </ul> * </li> * </ul> * * * * * * * * Related Resources * * <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_UploadPart.html">UploadPart</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> */ export class UploadPartCopyCommand extends $Command< UploadPartCopyCommandInput, UploadPartCopyCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: UploadPartCopyCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler<UploadPartCopyCommandInput, UploadPartCopyCommandOutput> { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getThrow200ExceptionsPlugin(configuration)); this.middlewareStack.use(getSsecPlugin(configuration)); this.middlewareStack.use(getBucketEndpointPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "UploadPartCopyCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: UploadPartCopyRequest.filterSensitiveLog, outputFilterSensitiveLog: UploadPartCopyOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments<any>) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: UploadPartCopyCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlUploadPartCopyCommand(input, context); } private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<UploadPartCopyCommandOutput> { return deserializeAws_restXmlUploadPartCopyCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }