@aws-sdk/client-s3

import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { PutObjectOutput, PutObjectRequest } from "../models/models_0"; import { deserializeAws_restXmlPutObjectCommand, serializeAws_restXmlPutObjectCommand } 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 PutObjectCommandInput = Omit<PutObjectRequest, "Body"> & { Body?: PutObjectRequest["Body"] | string | Uint8Array | Buffer; }; export type PutObjectCommandOutput = PutObjectOutput & __MetadataBearer; /** * Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object * to it. * * * Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the * entire object to the bucket. * * Amazon S3 is a distributed system. If it receives multiple write requests for the same object * simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object * locking; if you need this, make sure to build it into your application layer or use * versioning instead. * * To ensure that data is not corrupted traversing the network, use the * <code>Content-MD5</code> header. When you use this header, Amazon S3 checks the object * against the provided MD5 value and, if they do not match, returns an error. Additionally, * you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to * the calculated MD5 value. * <note> * The <code>Content-MD5</code> header is required for any request to upload an object * with a retention period configured using Amazon S3 Object Lock. For more information about * Amazon S3 Object Lock, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html">Amazon S3 Object Lock Overview</a> * in the Amazon Simple Storage Service Developer Guide. * </note> * * * * Server-side Encryption * * You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data * when you access it. You have the option to provide your own encryption key or use AWS * managed encryption keys (SSE-S3 or SSE-KMS). For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html">Using Server-Side * Encryption</a>. * If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html">Amazon S3 Bucket Keys</a> in the Amazon Simple Storage Service Developer Guide. * * Access Control List (ACL)-Specific Request * Headers * * You can use headers to grant ACL- based permissions. 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 ACL on the object. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List * (ACL) Overview</a> and <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html">Managing ACLs Using the REST * API</a>. * * * Storage Class Options * * By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The * STANDARD storage class provides high durability and high availability. Depending on * performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses * the OUTPOSTS Storage Class. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html">Storage Classes</a> in the Amazon S3 * Service Developer Guide. * * * * Versioning * * If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID * for the object being stored. Amazon S3 returns this ID in the response. When you enable * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object * simultaneously, it stores all of the objects. * For more information about versioning, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html">Adding Objects to * Versioning Enabled Buckets</a>. For information about returning the versioning state * of a bucket, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html">GetBucketVersioning</a>. * * * * Related Resources * * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html">CopyObject</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a> * * </li> * </ul> */ export class PutObjectCommand extends $Command<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig> { // Start section: command_properties // End section: command_properties constructor(readonly input: PutObjectCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler<PutObjectCommandInput, PutObjectCommandOutput> { 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 = "PutObjectCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: PutObjectRequest.filterSensitiveLog, outputFilterSensitiveLog: PutObjectOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments<any>) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: PutObjectCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlPutObjectCommand(input, context); } private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<PutObjectCommandOutput> { return deserializeAws_restXmlPutObjectCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }