@aws-sdk/client-s3

import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer, StreamingBlobPayloadInputTypes } from "@smithy/types"; import type { PutObjectOutput, PutObjectRequest } from "../models/models_0"; import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutObjectCommand}. */ export interface PutObjectCommandInput extends Omit<PutObjectRequest, "Body"> { Body?: StreamingBlobPayloadInputTypes; } /** * @public * * The output of {@link PutObjectCommand}. */ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBearer { } declare const PutObjectCommand_base: { new (input: PutObjectCommandInput): import("@smithy/smithy-client").CommandImpl<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: PutObjectCommandInput): import("@smithy/smithy-client").CommandImpl<PutObjectCommandInput, PutObjectCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <important> * End of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists (ACLs). If you attempt to use an Email Grantee ACL in a request after October 1, 2025, * the request will receive an <code>HTTP 405</code> (Method Not Allowed) error. * This change affects the following Amazon Web Services Regions: US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe (Ireland), and South America (São Paulo). * </important> * Adds an object to a bucket. * <note> * <ul> * <li> * Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire * object to the bucket. You cannot use <code>PutObject</code> to only update a single piece of * metadata for an existing object. You must put the entire object with updated metadata if you want * to update some values. * </li> * <li> * If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled * and no longer affect permissions. All objects written to the bucket by any account will be owned * by the bucket owner. * </li> * <li> * * 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 <code>https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name * </code>. Path-style requests are not supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the * Amazon S3 User Guide. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the * Amazon S3 User Guide. * </li> * </ul> * </note> * 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. However, Amazon S3 provides features that can * modify this behavior: * <ul> * <li> * * S3 Object Lock - To prevent objects from being deleted * or overwritten, you can use <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html">Amazon S3 Object Lock</a> in the Amazon S3 User Guide. * <note> * This functionality is not supported for directory buckets. * </note> * </li> * <li> * * If-None-Match - Uploads the object only if the object * key name does not already exist in the specified bucket. Otherwise, Amazon S3 returns a <code>412 * Precondition Failed</code> error. If a conflicting operation occurs during the upload, S3 returns * a <code>409 ConditionalRequestConflict</code> response. On a 409 failure, retry the upload. * Expects the * character (asterisk). * For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html">Add preconditions to S3 operations with * conditional requests</a> in the Amazon S3 User Guide or <a href="https://datatracker.ietf.org/doc/rfc7232/">RFC 7232</a>. * <note> * This functionality is not supported for S3 on Outposts. * </note> * </li> * <li> * * S3 Versioning - When you enable versioning for a bucket, * if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions * of the objects. For each write request that is made to the same object, Amazon S3 automatically generates * a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any * version of the object. 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> in the Amazon S3 User Guide. 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>. * <note> * This functionality is not supported for directory buckets. * </note> * </li> * </ul> * <dl> * <dt>Permissions</dt> * <dd> * <ul> * <li> * * General purpose bucket permissions - The following * permissions are required in your policies when your <code>PutObject</code> request includes * specific headers. * <ul> * <li> * * * <code>s3:PutObject</code> * - To successfully * complete the <code>PutObject</code> request, you must always have the * <code>s3:PutObject</code> permission on a bucket to add an object to it. * </li> * <li> * * * <code>s3:PutObjectAcl</code> * - To successfully change the objects ACL of your <code>PutObject</code> * request, you must have the <code>s3:PutObjectAcl</code>. * </li> * <li> * * * <code>s3:PutObjectTagging</code> * - To successfully set the tag-set with your <code>PutObject</code> * request, you must have the <code>s3:PutObjectTagging</code>. * </li> * </ul> * </li> * <li> * * Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"> * <code>CreateSession</code> * </a> API operation for session-based authorization. Specifically, you grant the <code>s3express:CreateSession</code> permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the <code>CreateSession</code> API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another <code>CreateSession</code> API call to generate a new session token for use. * Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateSession.html"> * <code>CreateSession</code> * </a>. * If the object is encrypted with SSE-KMS, you must also have the * <code>kms:GenerateDataKey</code> and <code>kms:Decrypt</code> permissions in IAM * identity-based policies and KMS key policies for the KMS key. * </li> * </ul> * </dd> * <dt>Data integrity with Content-MD5</dt> * <dd> * <ul> * <li> * * General purpose bucket - 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, Amazon S3 * returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate * the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 * value. * </li> * <li> * * Directory bucket - * This functionality is not supported for directory buckets. * </li> * </ul> * </dd> * <dt>HTTP Host header syntax</dt> * <dd> * * Directory buckets - The HTTP Host header syntax is <code> * Bucket-name.s3express-zone-id.region-code.amazonaws.com</code>. * </dd> * </dl> * <dl> * <dt>Errors</dt> * <dd> * <ul> * <li> * You might receive an <code>InvalidRequest</code> error for several reasons. Depending on the reason for the error, you might receive one of the following messages: * <ul> * <li> * Cannot specify both a write offset value and user-defined object metadata for existing * objects. * </li> * <li> * Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: * crc32c. * </li> * <li> * Request body cannot be empty when 'write offset' is specified. * </li> * </ul> * </li> * </ul> * </dd> * </dl> * For more information about related Amazon S3 APIs, see the following: * <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> * <important> * You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>. * </important> * @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 * // import type { S3ClientConfig } from "@aws-sdk/client-s3"; * const config = {}; // type is S3ClientConfig * const client = new S3Client(config); * const input = { // PutObjectRequest * ACL: "private" || "public-read" || "public-read-write" || "authenticated-read" || "aws-exec-read" || "bucket-owner-read" || "bucket-owner-full-control", * Body: "MULTIPLE_TYPES_ACCEPTED", // see \@smithy/types -> StreamingBlobPayloadInputTypes * Bucket: "STRING_VALUE", // required * CacheControl: "STRING_VALUE", * ContentDisposition: "STRING_VALUE", * ContentEncoding: "STRING_VALUE", * ContentLanguage: "STRING_VALUE", * ContentLength: Number("long"), * ContentMD5: "STRING_VALUE", * ContentType: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME", * ChecksumCRC32: "STRING_VALUE", * ChecksumCRC32C: "STRING_VALUE", * ChecksumCRC64NVME: "STRING_VALUE", * ChecksumSHA1: "STRING_VALUE", * ChecksumSHA256: "STRING_VALUE", * Expires: new Date("TIMESTAMP"), * IfMatch: "STRING_VALUE", * IfNoneMatch: "STRING_VALUE", * GrantFullControl: "STRING_VALUE", * GrantRead: "STRING_VALUE", * GrantReadACP: "STRING_VALUE", * GrantWriteACP: "STRING_VALUE", * Key: "STRING_VALUE", // required * WriteOffsetBytes: Number("long"), * Metadata: { // Metadata * "<keys>": "STRING_VALUE", * }, * ServerSideEncryption: "AES256" || "aws:fsx" || "aws:kms" || "aws:kms:dsse", * StorageClass: "STANDARD" || "REDUCED_REDUNDANCY" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "GLACIER" || "DEEP_ARCHIVE" || "OUTPOSTS" || "GLACIER_IR" || "SNOW" || "EXPRESS_ONEZONE" || "FSX_OPENZFS" || "FSX_ONTAP", * WebsiteRedirectLocation: "STRING_VALUE", * SSECustomerAlgorithm: "STRING_VALUE", * SSECustomerKey: "STRING_VALUE", * SSECustomerKeyMD5: "STRING_VALUE", * SSEKMSKeyId: "STRING_VALUE", * SSEKMSEncryptionContext: "STRING_VALUE", * BucketKeyEnabled: true || false, * RequestPayer: "requester", * Tagging: "STRING_VALUE", * ObjectLockMode: "GOVERNANCE" || "COMPLIANCE", * ObjectLockRetainUntilDate: new Date("TIMESTAMP"), * ObjectLockLegalHoldStatus: "ON" || "OFF", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * // { // PutObjectOutput * // Expiration: "STRING_VALUE", * // ETag: "STRING_VALUE", * // ChecksumCRC32: "STRING_VALUE", * // ChecksumCRC32C: "STRING_VALUE", * // ChecksumCRC64NVME: "STRING_VALUE", * // ChecksumSHA1: "STRING_VALUE", * // ChecksumSHA256: "STRING_VALUE", * // ChecksumType: "COMPOSITE" || "FULL_OBJECT", * // ServerSideEncryption: "AES256" || "aws:fsx" || "aws:kms" || "aws:kms:dsse", * // VersionId: "STRING_VALUE", * // SSECustomerAlgorithm: "STRING_VALUE", * // SSECustomerKeyMD5: "STRING_VALUE", * // SSEKMSKeyId: "STRING_VALUE", * // SSEKMSEncryptionContext: "STRING_VALUE", * // BucketKeyEnabled: true || false, * // Size: Number("long"), * // RequestCharged: "requester", * // }; * * ``` * * @param PutObjectCommandInput - {@link PutObjectCommandInput} * @returns {@link PutObjectCommandOutput} * @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. * * @throws {@link EncryptionTypeMismatch} (client fault) * The existing object was created with a different encryption type. Subsequent write requests must * include the appropriate encryption parameters in the request or while creating the session. * * @throws {@link InvalidRequest} (client fault) * A parameter or header in your request isn't valid. For details, see the description of this API * operation. * * @throws {@link InvalidWriteOffset} (client fault) * The write offset value that you specified does not match the current object size. * * @throws {@link TooManyParts} (client fault) * You have attempted to add more parts than the maximum of 10000 that are allowed for this object. * You can use the CopyObject operation to copy this object to another and then add more data to the newly * copied object. * * @throws {@link S3ServiceException} * Base exception class for all service exceptions from S3 service. * * * @example To create an object. * ```javascript * // The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response. * const input = { * Body: "filetoupload", * Bucket: "examplebucket", * Key: "objectkey" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * VersionId: "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" * } * *\/ * ``` * * @example To upload an object (specify optional headers) * ```javascript * // The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption. * const input = { * Body: "HappyFace.jpg", * Bucket: "examplebucket", * Key: "HappyFace.jpg", * ServerSideEncryption: "AES256", * StorageClass: "STANDARD_IA" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * ServerSideEncryption: "AES256", * VersionId: "CG612hodqujkf8FaaNfp8U..FIhLROcp" * } * *\/ * ``` * * @example To upload an object * ```javascript * // The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object. * const input = { * Body: "HappyFace.jpg", * Bucket: "examplebucket", * Key: "HappyFace.jpg" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * VersionId: "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" * } * *\/ * ``` * * @example To upload an object and specify canned ACL. * ```javascript * // The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response. * const input = { * ACL: "authenticated-read", * Body: "filetoupload", * Bucket: "examplebucket", * Key: "exampleobject" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * VersionId: "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" * } * *\/ * ``` * * @example To upload an object and specify optional tags * ```javascript * // The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object. * const input = { * Body: "c:\HappyFace.jpg", * Bucket: "examplebucket", * Key: "HappyFace.jpg", * Tagging: "key1=value1&key2=value2" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * VersionId: "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" * } * *\/ * ``` * * @example To upload an object and specify server-side encryption and object tags * ```javascript * // The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response. * const input = { * Body: "filetoupload", * Bucket: "examplebucket", * Key: "exampleobject", * ServerSideEncryption: "AES256", * Tagging: "key1=value1&key2=value2" * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * ServerSideEncryption: "AES256", * VersionId: "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" * } * *\/ * ``` * * @example To upload object and specify user-defined metadata * ```javascript * // The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response. * const input = { * Body: "filetoupload", * Bucket: "examplebucket", * Key: "exampleobject", * Metadata: { * metadata1: "value1", * metadata2: "value2" * } * }; * const command = new PutObjectCommand(input); * const response = await client.send(command); * /* response is * { * ETag: `"6805f2cfc46c0f04559748bb039d69ae"`, * VersionId: "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" * } * *\/ * ``` * * @public */ export declare class PutObjectCommand extends PutObjectCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutObjectRequest; output: PutObjectOutput; }; sdk: { input: PutObjectCommandInput; output: PutObjectCommandOutput; }; }; }