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 { CreateMultipartUploadOutput, CreateMultipartUploadRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; export interface CreateMultipartUploadCommandInput extends CreateMultipartUploadRequest { } export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploadOutput, __MetadataBearer { } /** *

This action initiates a multipart upload and returns an upload ID. This upload ID is * used to associate all of the parts in the specific multipart upload. You specify this * upload ID in each of your subsequent upload part requests (see UploadPart). You also include this * upload ID in the final request to either complete or abort the multipart upload * request.

* *

For more information about multipart uploads, see Multipart Upload Overview.

* *

If you have configured a lifecycle rule to abort incomplete multipart uploads, the * upload must complete within the number of days specified in the bucket lifecycle * configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort * action and Amazon S3 aborts the multipart upload. For more information, see Aborting * Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.

* *

For information about the permissions required to use the multipart upload API, see * Multipart Upload and * Permissions.

* *

For request signing, multipart upload is just a series of regular requests. You initiate * a multipart upload, send one or more requests to upload parts, and then complete the * multipart upload process. You sign each request individually. There is nothing special * about signing multipart upload requests. For more information about signing, see Authenticating * Requests (Amazon Web Services Signature Version 4).

* * *

After you initiate a multipart upload and upload one or more parts, to stop being * charged for storing the uploaded parts, you must either complete or abort the multipart * upload. Amazon S3 frees up the space used to store the parts and stop charging you for * storing them only after you either complete or abort a multipart upload.

* * *

You can optionally request server-side encryption. For server-side encryption, Amazon S3 * encrypts your data as it writes it to disks in its data centers and decrypts it when you * access it. You can provide your own encryption key, or use Amazon Web Services KMS keys or Amazon S3-managed encryption keys. If you choose to provide * your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to * initiate the upload by using CreateMultipartUpload.

*

To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must * have permission to the kms:Decrypt and kms:GenerateDataKey* * actions on the key. These permissions are required because Amazon S3 must decrypt and read data * from the encrypted file parts before it completes the multipart upload. For more * information, see Multipart upload API * and permissions in the Amazon S3 User Guide.

* *

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account * as the KMS key, then you must have these permissions on the key policy. If your IAM * user or role belongs to a different account than the key, then you must have the * permissions on both the key policy and your IAM user or role.

* * *

For more information, see Protecting * Data Using Server-Side Encryption.

* *
*
Access Permissions
*
*

When copying an object, you can optionally specify the accounts or groups that * should be granted specific permissions on the new object. There are two ways to * grant the permissions using the request headers:

* *

You can use either a canned ACL or specify access permissions explicitly. You * cannot do both.

*
*
Server-Side- Encryption-Specific Request Headers
*
*

You can optionally tell Amazon S3 to encrypt data at rest using server-side * encryption. 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. The option you use depends on whether you want to use Amazon Web Services managed * encryption keys or provide your own encryption key.

* *
*
Access-Control-List (ACL)-Specific Request Headers
*
*

You also can use the following access control–related headers with this * operation. By default, all objects are private. Only the owner has full access * control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added * to the access control list (ACL) on the object. For more information, see Using ACLs. With this * operation, you can grant access permissions using one of the following two * methods:

* * *
*
* *

The following operations are related to CreateMultipartUpload:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, CreateMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, CreateMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const command = new CreateMultipartUploadCommand(input); * const response = await client.send(command); * ``` * * @see {@link CreateMultipartUploadCommandInput} for command's `input` shape. * @see {@link CreateMultipartUploadCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * */ export declare class CreateMultipartUploadCommand extends $Command { readonly input: CreateMultipartUploadCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; constructor(input: CreateMultipartUploadCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler; private serialize; private deserialize; }