@aws-sdk/client-s3

/// <reference types="node" /> import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { PutObjectOutput, PutObjectRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; declare type PutObjectCommandInputType = Omit<PutObjectRequest, "Body"> & { /** * For *`PutObjectRequest["Body"]`*, see {@link PutObjectRequest.Body}. */ Body?: PutObjectRequest["Body"] | string | Uint8Array | Buffer; }; /** * This interface extends from `PutObjectRequest` interface. There are more parameters than `Body` defined in {@link PutObjectRequest} */ export interface PutObjectCommandInput extends PutObjectCommandInputType { } export interface PutObjectCommandOutput extends 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> * <ul> * <li> * To successfully complete the <code>PutObject</code> request, you must have the * <code>s3:PutObject</code> in your IAM permissions. * </li> * <li> * To successfully change the objects acl of your <code>PutObject</code> request, * you must have the <code>s3:PutObjectAcl</code> in your IAM permissions. * </li> * <li> * 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 S3 User Guide. * </li> * </ul> * </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 Amazon Web Services * 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 Amazon Web Services 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 S3 User 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 Amazon Web Services 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>. * If the bucket that you're uploading objects to uses the bucket owner enforced setting * for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that * use this setting only accept PUT requests that don't specify an ACL or PUT requests that * specify bucket owner full control ACLs, such as the <code>bucket-owner-full-control</code> canned * ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other * ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a * <code>400</code> error with the error code * <code>AccessControlListNotSupported</code>. * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html"> Controlling ownership of * objects and disabling ACLs</a> in the Amazon S3 User Guide. * <note> * If your bucket uses the bucket owner enforced setting for Object Ownership, * all objects written to the bucket by any account will be owned by the bucket owner. * </note> * * 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 User 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> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutObjectCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const command = new PutObjectCommand(input); * const response = await client.send(command); * ``` * * @see {@link PutObjectCommandInput} for command's `input` shape. * @see {@link PutObjectCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * */ export declare class PutObjectCommand extends $Command<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig> { readonly input: PutObjectCommandInput; constructor(input: PutObjectCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutObjectCommandInput, PutObjectCommandOutput>; private serialize; private deserialize; } export {};