Container for the parameters to the PutObjectRetention operation.
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.
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class PutObjectRetentionRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The PutObjectRetentionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutObjectRetentionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
BucketName | System.String |
Gets and sets the property BucketName. The bucket name that contains the object you want to apply this Object Retention configuration to. Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. |
|
|
BypassGovernanceRetention | System.Boolean |
Gets and sets the property BypassGovernanceRetention. Indicates whether this action should bypass Governance-mode restrictions. |
|
|
ChecksumAlgorithm | Amazon.S3.ChecksumAlgorithm |
Gets and sets the property ChecksumAlgorithm.
Indicates the algorithm used to create the checksum for the object when you use the
SDK. This header will not provide any additional functionality if you don't use the
SDK. When you send this header, there must be a corresponding
If you provide an individual checksum, Amazon S3 ignores any provided |
|
|
ContentMD5 | System.String |
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. |
|
|
ExpectedBucketOwner | System.String |
Gets and sets the property ExpectedBucketOwner.
The account ID of the expected bucket owner. If the account ID that you provide does
not match the actual owner of the bucket, the request fails with the HTTP status code
|
|
|
Key | System.String |
Gets and sets the property Key. The key name for the object that you want to apply this Object Retention configuration to. |
|
|
RequestPayer | Amazon.S3.RequestPayer |
Gets and sets the property RequestPayer. |
|
|
Retention | Amazon.S3.Model.ObjectLockRetention |
Gets and sets the property Retention. The container element for the Object Retention configuration. |
|
|
VersionId | System.String |
Gets and sets the property VersionId. The version ID for the object that you want to apply this Object Retention configuration to. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5