import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { PutObjectRetentionOutput, PutObjectRetentionRequest } from "../models/models_1"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link PutObjectRetentionCommand}. */ export interface PutObjectRetentionCommandInput extends PutObjectRetentionRequest { } /** * @public * * The output of {@link PutObjectRetentionCommand}. */ export interface PutObjectRetentionCommandOutput extends PutObjectRetentionOutput, __MetadataBearer { } /** * @public *
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 action is not supported by 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); * ``` * * @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. * * */ export declare class PutObjectRetentionCommand extends $Command