import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { UploadPartCopyOutput, UploadPartCopyRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UploadPartCopyCommand}. */ export interface UploadPartCopyCommandInput extends UploadPartCopyRequest { } /** * @public * * The output of {@link UploadPartCopyCommand}. */ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __MetadataBearer { } declare const UploadPartCopyCommand_base: { new (input: UploadPartCopyCommandInput): import("@smithy/smithy-client").CommandImpl; new (__0_0: UploadPartCopyCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Uploads a part by copying data from an existing object as data source. To specify the * data source, you add the request header x-amz-copy-source in your request. To specify * a byte range, you add the request header x-amz-copy-source-range in your * request.

For information about maximum and minimum part sizes and other multipart upload * specifications, see Multipart upload limits in the Amazon S3 User Guide.

* *

Instead of copying data from an existing object as part data, you might use the UploadPart * action to upload new data as a part of an object in your request.

* *

You must initiate a multipart upload before you can upload any part. In response to your * initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in * your upload part request.

For conceptual information about multipart uploads, see Uploading * Objects Using Multipart Upload in the * Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart * upload, see Operations on Objects in * the Amazon S3 User Guide.

* *

* Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name *. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the * Amazon S3 User Guide.

* *

Authentication and authorization

All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including * x-amz-copy-source, must be signed. For more information, see REST Authentication.

* Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the * temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have READ access to the source object and WRITE * access to the destination bucket.

*
* General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.
*
- *
  If the source object is in a general purpose bucket, you must have the * s3:GetObject * permission to read the source object that is being copied.
  *
- *
  If the destination bucket is a general purpose bucket, you must have the * s3:PutObject * permission to write the object copy to the destination bucket. *
  *
*
For information about permissions required to use the multipart upload API, see * Multipart upload API and permissions in the * Amazon S3 User Guide.
*
*
* Directory bucket permissions - * You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination * bucket types in an UploadPartCopy operation.
*
- *
  If the source object that you want to copy is in a * directory bucket, you must have the * s3express:CreateSession * permission in * the Action element of a policy to read the object. By * default, the session is in the ReadWrite mode. If you * want to restrict the access, you can explicitly set the * s3express:SessionMode condition key to * ReadOnly on the copy source bucket.
  *
- *
  If the copy destination is a directory bucket, you must have the * * s3express:CreateSession * permission in the * Action element of a policy to write the object * to the destination. The s3express:SessionMode condition * key cannot be set to ReadOnly on the copy destination.
  *
*
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the * Amazon S3 User Guide.
*

Encryption

*
* General purpose buckets - * * For information about using server-side encryption with customer-provided * encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart. *
*
*
* Directory buckets - For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is supported.
*

Special errors

*
Error Code: NoSuchUpload *
*
- *
  Description: The specified multipart upload does not exist. The * upload ID might be invalid, or the multipart upload might have been * aborted or completed.
  *
- *
  HTTP Status Code: 404 Not Found
  *
*
*
Error Code: InvalidRequest *
*
- *
  Description: The specified copy source is not supported as a * byte-range copy source.
  *
- *
  HTTP Status Code: 400 Bad Request
  *
*

HTTP Host header syntax

* Directory buckets - The HTTP Host header syntax is * Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPartCopy:

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, UploadPartCopyCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, UploadPartCopyCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // UploadPartCopyRequest * Bucket: "STRING_VALUE", // required * CopySource: "STRING_VALUE", // required * CopySourceIfMatch: "STRING_VALUE", * CopySourceIfModifiedSince: new Date("TIMESTAMP"), * CopySourceIfNoneMatch: "STRING_VALUE", * CopySourceIfUnmodifiedSince: new Date("TIMESTAMP"), * CopySourceRange: "STRING_VALUE", * Key: "STRING_VALUE", // required * PartNumber: Number("int"), // required * UploadId: "STRING_VALUE", // required * SSECustomerAlgorithm: "STRING_VALUE", * SSECustomerKey: "STRING_VALUE", * SSECustomerKeyMD5: "STRING_VALUE", * CopySourceSSECustomerAlgorithm: "STRING_VALUE", * CopySourceSSECustomerKey: "STRING_VALUE", * CopySourceSSECustomerKeyMD5: "STRING_VALUE", * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", * ExpectedSourceBucketOwner: "STRING_VALUE", * }; * const command = new UploadPartCopyCommand(input); * const response = await client.send(command); * // { // UploadPartCopyOutput * // CopySourceVersionId: "STRING_VALUE", * // CopyPartResult: { // CopyPartResult * // ETag: "STRING_VALUE", * // LastModified: new Date("TIMESTAMP"), * // ChecksumCRC32: "STRING_VALUE", * // ChecksumCRC32C: "STRING_VALUE", * // ChecksumSHA1: "STRING_VALUE", * // ChecksumSHA256: "STRING_VALUE", * // }, * // ServerSideEncryption: "AES256" || "aws:kms" || "aws:kms:dsse", * // SSECustomerAlgorithm: "STRING_VALUE", * // SSECustomerKeyMD5: "STRING_VALUE", * // SSEKMSKeyId: "STRING_VALUE", * // BucketKeyEnabled: true || false, * // RequestCharged: "requester", * // }; * * ``` * * @param UploadPartCopyCommandInput - {@link UploadPartCopyCommandInput} * @returns {@link UploadPartCopyCommandOutput} * @see {@link UploadPartCopyCommandInput} for command's `input` shape. * @see {@link UploadPartCopyCommandOutput} 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.

* * @public * @example To upload a part by copying data from an existing object as data source * ```javascript * // The following example uploads a part of a multipart upload by copying data from an existing object as data source. * const input = { * "Bucket": "examplebucket", * "CopySource": "/bucketname/sourceobjectkey", * "Key": "examplelargeobject", * "PartNumber": "1", * "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" * }; * const command = new UploadPartCopyCommand(input); * const response = await client.send(command); * /* response == * { * "CopyPartResult": { * "ETag": "\"b0c6f0e7e054ab8fa2536a2677f8734d\"", * "LastModified": "2016-12-29T21:24:43.000Z" * } * } * *\/ * // example id: to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348 * ``` * * @example To upload a part by copying byte range from an existing object as data source * ```javascript * // The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source. * const input = { * "Bucket": "examplebucket", * "CopySource": "/bucketname/sourceobjectkey", * "CopySourceRange": "bytes=1-100000", * "Key": "examplelargeobject", * "PartNumber": "2", * "UploadId": "exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--" * }; * const command = new UploadPartCopyCommand(input); * const response = await client.send(command); * /* response == * { * "CopyPartResult": { * "ETag": "\"65d16d19e65a7508a51f043180edcc36\"", * "LastModified": "2016-12-29T21:44:28.000Z" * } * } * *\/ * // example id: to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594 * ``` * */ export declare class UploadPartCopyCommand extends UploadPartCopyCommand_base { }