@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
235 lines • 11.5 kB
JavaScript
import { __extends } from "tslib";
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 { Command as $Command } from "@aws-sdk/smithy-client";
/**
* <p>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. </p>
* <p>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 <i>Amazon Simple Storage Service Developer Guide</i>. </p>
* <note>
* <p>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.</p>
* </note>
*
* <p>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.</p>
* <p>For more information about using the <code>UploadPartCopy</code> operation, see the
* following:</p>
*
* <ul>
* <li>
* <p>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 <i>Amazon Simple Storage Service Developer Guide</i>.</p>
* </li>
* <li>
* <p>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 <i>Amazon Simple Storage Service Developer Guide</i>.</p>
* </li>
* <li>
* <p>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 <i>Amazon Simple Storage Service Developer Guide</i>.</p>
* </li>
* <li>
* <p>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>.</p>
* </li>
* </ul>
* <p>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>:</p>
* <p> </p>
* <ul>
* <li>
* <p>
* <b>Consideration 1</b> - 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:</p>
* <p>
* <code>x-amz-copy-source-if-match</code> condition evaluates to <code>true</code>,
* and;</p>
* <p>
* <code>x-amz-copy-source-if-unmodified-since</code> condition evaluates to
* <code>false</code>;</p>
* <p>Amazon S3 returns <code>200 OK</code> and copies the data.
* </p>
*
* </li>
* <li>
* <p>
* <b>Consideration 2</b> - 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:</p>
* <p>
* <code>x-amz-copy-source-if-none-match</code> condition evaluates to
* <code>false</code>, and;</p>
* <p>
* <code>x-amz-copy-source-if-modified-since</code> condition evaluates to
* <code>true</code>;</p>
* <p>Amazon S3 returns <code>412 Precondition Failed</code> response code.
* </p>
* </li>
* </ul>
* <p>
* <b>Versioning</b>
* </p>
* <p>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>. </p>
* <p>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:</p>
* <p>
* <code>x-amz-copy-source: /bucket/object?versionId=version id</code>
* </p>
*
* <p class="title">
* <b>Special Errors</b>
* </p>
* <ul>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: NoSuchUpload</i>
* </p>
* </li>
* <li>
* <p>
* <i>Cause: The specified multipart upload does not exist. The upload
* ID might be invalid, or the multipart upload might have been aborted or
* completed.</i>
* </p>
* </li>
* <li>
* <p>
* <i>HTTP Status Code: 404 Not Found</i>
* </p>
* </li>
* </ul>
* </li>
* <li>
* <ul>
* <li>
* <p>
* <i>Code: InvalidRequest</i>
* </p>
* </li>
* <li>
* <p>
* <i>Cause: The specified copy source is not supported as a byte-range
* copy source.</i>
* </p>
* </li>
* <li>
* <p>
* <i>HTTP Status Code: 400 Bad Request</i>
* </p>
* </li>
* </ul>
* </li>
* </ul>
*
*
*
*
*
*
* <p class="title">
* <b>Related Resources</b>
* </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_ListParts.html">ListParts</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html">ListMultipartUploads</a>
* </p>
* </li>
* </ul>
*/
var UploadPartCopyCommand = /** @class */ (function (_super) {
__extends(UploadPartCopyCommand, _super);
// Start section: command_properties
// End section: command_properties
function UploadPartCopyCommand(input) {
var _this =
// Start section: command_constructor
_super.call(this) || this;
_this.input = input;
return _this;
// End section: command_constructor
}
/**
* @internal
*/
UploadPartCopyCommand.prototype.resolveMiddleware = function (clientStack, configuration, options) {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getThrow200ExceptionsPlugin(configuration));
this.middlewareStack.use(getSsecPlugin(configuration));
this.middlewareStack.use(getBucketEndpointPlugin(configuration));
var stack = clientStack.concat(this.middlewareStack);
var logger = configuration.logger;
var clientName = "S3Client";
var commandName = "UploadPartCopyCommand";
var handlerExecutionContext = {
logger: logger,
clientName: clientName,
commandName: commandName,
inputFilterSensitiveLog: UploadPartCopyRequest.filterSensitiveLog,
outputFilterSensitiveLog: UploadPartCopyOutput.filterSensitiveLog,
};
var requestHandler = configuration.requestHandler;
return stack.resolve(function (request) {
return requestHandler.handle(request.request, options || {});
}, handlerExecutionContext);
};
UploadPartCopyCommand.prototype.serialize = function (input, context) {
return serializeAws_restXmlUploadPartCopyCommand(input, context);
};
UploadPartCopyCommand.prototype.deserialize = function (output, context) {
return deserializeAws_restXmlUploadPartCopyCommand(output, context);
};
return UploadPartCopyCommand;
}($Command));
export { UploadPartCopyCommand };
//# sourceMappingURL=UploadPartCopyCommand.js.map