AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to PutObjectRetentionAsync.

Namespace: Amazon.S3
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C#
public virtual PutObjectRetentionResponse PutObjectRetention(
         PutObjectRetentionRequest request
)

Parameters

request
Type: Amazon.S3.Model.PutObjectRetentionRequest

Container for the necessary parameters to execute the PutObjectRetention service method.

Return Value


The response from the PutObjectRetention service method, as returned by S3.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also