Table of Contents

Class PutObjectRetentionRequest

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Container for the parameters to the PutObjectRetention operation. 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.

Permissions

When the Object Lock retention mode is set to compliance, you need 

s3:PutObjectRetention
and 
s3:BypassGovernanceRetention
permissions. For other requests to 
PutObjectRetention
, only 
s3:PutObjectRetention
permissions are required. 
public class PutObjectRetentionRequest : AmazonWebServiceRequest
Inheritance
PutObjectRetentionRequest

Constructors

PutObjectRetentionRequest() 

public PutObjectRetentionRequest()

Properties

BucketName

Gets and sets the property BucketName.

The bucket name that contains the object you want to apply this Object Retention configuration to.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide. 

public string BucketName { get; set; }

Property Value

string

BypassGovernanceRetention

Gets and sets the property BypassGovernanceRetention.

Indicates whether this action should bypass Governance-mode restrictions. 

public bool BypassGovernanceRetention { get; set; }

Property Value

bool

ChecksumAlgorithm

Gets and sets the property ChecksumAlgorithm.

Indicates the algorithm used to create the checksum for the object. Amazon S3 will fail the request with a 400 error if there is no checksum associated with the object. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public ChecksumAlgorithm ChecksumAlgorithm { get; set; }

Property Value

ChecksumAlgorithm

ContentMD5

Gets and sets the property ContentMD5.

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically. 

public string ContentMD5 { get; set; }

Property Value

string

ExpectedBucketOwner

Gets and sets the property ExpectedBucketOwner.

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 

403 (Access Denied)
error. 
public string ExpectedBucketOwner { get; set; }

Property Value

string

Key

Gets and sets the property Key.

The key name for the object that you want to apply this Object Retention configuration to. 

public string Key { get; set; }

Property Value

string

Remarks

This property will be used as part of the resource path of the HTTP request. In .NET the System.Uri class is used to construct the uri for the request. The System.Uri class will canonicalize the uri string by compacting characters like "..". /// For example an object key of "foo/../bar/file.txt" will be transformed into "bar/file.txt" because the ".." is interpreted as use parent directory. For further information view the documentation for the Uri class: https://docs.microsoft.com/en-us/dotnet/api/system.uri

RequestPayer

Gets and sets the property RequestPayer.

public RequestPayer RequestPayer { get; set; }

Property Value

RequestPayer

Retention

Gets and sets the property Retention.

The container element for the Object Retention configuration. 

public ObjectLockRetention Retention { get; set; }

Property Value

ObjectLockRetention

VersionId

Gets and sets the property VersionId.

The version ID for the object that you want to apply this Object Retention configuration to. 

public string VersionId { get; set; }

Property Value

string