Table of Contents

Class PutObjectLegalHoldRequest

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

Container for the parameters to the PutObjectLegalHold operation. Applies a Legal Hold configuration to the specified object.

public class PutObjectLegalHoldRequest : AmazonWebServiceRequest
Inheritance
PutObjectLegalHoldRequest

Constructors

PutObjectLegalHoldRequest()

public PutObjectLegalHoldRequest()

Properties

BucketName

The bucket name containing the object that you want to place a Legal Hold on.

When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.

public string BucketName { get; set; }

Property Value

string

ContentMD5

Gets and sets the property ContentMD5.

The MD5 signature for the configuration included in your request.

public string ContentMD5 { get; set; }

Property Value

string

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 place a Legal Hold on.

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

LegalHold

Gets and sets the property LegalHold.

Container element for the Legal Hold configuration you want to apply to the specified object.

public ObjectLockLegalHold LegalHold { get; set; }

Property Value

ObjectLockLegalHold

RequestPayer

Gets and sets the property RequestPayer.

public RequestPayer RequestPayer { get; set; }

Property Value

RequestPayer

VersionId

Gets and sets the property VersionId.

The version ID of the object that you want to place a Legal Hold on.

public string VersionId { get; set; }

Property Value

string