Table of Contents

Class GetObjectRetentionRequest

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

Container for the parameters to the GetObjectRetention operation. Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to

GetObjectRetention
:
public class GetObjectRetentionRequest : AmazonWebServiceRequest
Inheritance
GetObjectRetentionRequest

Constructors

GetObjectRetentionRequest()

public GetObjectRetentionRequest()

Properties

BucketName

Gets and sets the property BucketName.

The bucket name containing the object whose retention settings you want to retrieve.

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

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 whose retention settings you want to retrieve.

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

VersionId

Gets and sets the property VersionId.

The version ID for the object whose retention settings you want to retrieve.

public string VersionId { get; set; }

Property Value

string