Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PutObjectRetentionRequest

Hierarchy

  • PutObjectRetentionRequest

Index

Properties

Bucket

Bucket: string

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 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 S3 User Guide.

Optional BypassGovernanceRetention

BypassGovernanceRetention: boolean

Indicates whether this action should bypass Governance-mode restrictions.

Optional ContentMD5

ContentMD5: string

The MD5 hash for the request body. For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Optional ExpectedBucketOwner

ExpectedBucketOwner: string

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.

Key

Key: string

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

Optional RequestPayer

RequestPayer: string

Optional Retention

The container element for the Object Retention configuration.

Optional VersionId

VersionId: string

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

Generated using TypeDoc