import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { CreateMultipartUploadOutput, CreateMultipartUploadRequest } from "../models/models_0"; import { deserializeAws_restXmlCreateMultipartUploadCommand, serializeAws_restXmlCreateMultipartUploadCommand, } from "../protocols/Aws_restXml"; import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint"; 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 CreateMultipartUploadCommandInput = CreateMultipartUploadRequest; export type CreateMultipartUploadCommandOutput = CreateMultipartUploadOutput & __MetadataBearer; /** *

This operation 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 * operation 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 API 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 (AWS 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 AWS Key Management Service (AWS * KMS) customer master keys (CMKs) 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 AWS KMS CMK, the requester must * have permission to the kms:Encrypt, kms:Decrypt, * kms:ReEncrypt*, kms:GenerateDataKey*, and * kms:DescribeKey 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.

* *

If your AWS Identity and Access Management (IAM) user or role is in the same AWS account * as the AWS KMS CMK, 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 AWS 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 AWS * 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:

* */ export class CreateMultipartUploadCommand extends $Command< CreateMultipartUploadCommandInput, CreateMultipartUploadCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: CreateMultipartUploadCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getSsecPlugin(configuration)); this.middlewareStack.use(getBucketEndpointPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "CreateMultipartUploadCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: CreateMultipartUploadRequest.filterSensitiveLog, outputFilterSensitiveLog: CreateMultipartUploadOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: CreateMultipartUploadCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlCreateMultipartUploadCommand(input, context); } private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { return deserializeAws_restXmlCreateMultipartUploadCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }