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

This operation is not supported by directory buckets.

*
*

Places an Object Retention configuration on an object. For more information, see Locking Objects. * Users or accounts require the s3:PutObjectRetention permission in order to * place an Object Retention configuration on objects. Bypassing a Governance Retention * configuration requires the s3:BypassGovernanceRetention permission.

*

This functionality is not supported for Amazon S3 on Outposts.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutObjectRetentionCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutObjectRetentionCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // PutObjectRetentionRequest * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * Retention: { // ObjectLockRetention * Mode: "GOVERNANCE" || "COMPLIANCE", * RetainUntilDate: new Date("TIMESTAMP"), * }, * RequestPayer: "requester", * VersionId: "STRING_VALUE", * BypassGovernanceRetention: true || false, * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutObjectRetentionCommand(input); * const response = await client.send(command); * // { // PutObjectRetentionOutput * // RequestCharged: "requester", * // }; * * ``` * * @param PutObjectRetentionCommandInput - {@link PutObjectRetentionCommandInput} * @returns {@link PutObjectRetentionCommandOutput} * @see {@link PutObjectRetentionCommandInput} for command's `input` shape. * @see {@link PutObjectRetentionCommandOutput} 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 */ export declare class PutObjectRetentionCommand extends PutObjectRetentionCommand_base { }