import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutObjectTaggingOutput, PutObjectTaggingRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutObjectTaggingCommand}. */ export interface PutObjectTaggingCommandInput extends PutObjectTaggingRequest { } /** * @public * * The output of {@link PutObjectTaggingCommand}. */ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, __MetadataBearer { } declare const PutObjectTaggingCommand_base: { new (input: PutObjectTaggingCommandInput): import("@smithy/smithy-client").CommandImpl; new (__0_0: PutObjectTaggingCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

This operation is not supported by directory buckets.

*
*

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a * key-value pair. For more information, see Object Tagging.

*

You can associate tags with an object by sending a PUT request against the tagging * subresource that is associated with the object. You can retrieve tags by sending a GET * request. For more information, see GetObjectTagging.

*

For tagging-related restrictions related to characters and encodings, see Tag * Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per * object.

*

To use this operation, you must have permission to perform the * s3:PutObjectTagging action. By default, the bucket owner has this * permission and can grant this permission to others.

*

To put tags of any other version, use the versionId query parameter. You * also need permission for the s3:PutObjectVersionTagging action.

*

* PutObjectTagging has the following special errors. For more Amazon S3 errors * see, Error * Responses.

* *

The following operations are related to PutObjectTagging:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutObjectTaggingCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutObjectTaggingCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // PutObjectTaggingRequest * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * VersionId: "STRING_VALUE", * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256", * Tagging: { // Tagging * TagSet: [ // TagSet // required * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }, * ExpectedBucketOwner: "STRING_VALUE", * RequestPayer: "requester", * }; * const command = new PutObjectTaggingCommand(input); * const response = await client.send(command); * // { // PutObjectTaggingOutput * // VersionId: "STRING_VALUE", * // }; * * ``` * * @param PutObjectTaggingCommandInput - {@link PutObjectTaggingCommandInput} * @returns {@link PutObjectTaggingCommandOutput} * @see {@link PutObjectTaggingCommandInput} for command's `input` shape. * @see {@link PutObjectTaggingCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} *

Base exception class for all service exceptions from S3 service.

* * @public * @example To add tags to an existing object * ```javascript * // The following example adds tags to an existing object. * const input = { * "Bucket": "examplebucket", * "Key": "HappyFace.jpg", * "Tagging": { * "TagSet": [ * { * "Key": "Key3", * "Value": "Value3" * }, * { * "Key": "Key4", * "Value": "Value4" * } * ] * } * }; * const command = new PutObjectTaggingCommand(input); * const response = await client.send(command); * /* response == * { * "VersionId": "null" * } * *\/ * // example id: to-add-tags-to-an-existing-object-1481764668793 * ``` * */ export declare class PutObjectTaggingCommand extends PutObjectTaggingCommand_base { }