Class: Aws::S3::Types::PutObjectRetentionRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::PutObjectRetentionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutObjectRetentionRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  retention: {
    mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
    retain_until_date: Time.now,
  },
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
  bypass_governance_retention: false,
  content_md5: "ContentMD5",
  expected_bucket_owner: "AccountId",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #bypass_governance_retention ⇒ Boolean

  Indicates whether this operation should bypass Governance-mode restrictions.

• #content_md5 ⇒ String

  The MD5 hash for the request body.

• #expected_bucket_owner ⇒ String

  The account id of the expected bucket owner.

• #key ⇒ String

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

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

• #retention ⇒ Types::ObjectLockRetention

  The container element for the Object Retention configuration.

• #version_id ⇒ String

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

Instance Attribute Details

#bucket ⇒ String

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

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*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#bypass_governance_retention ⇒ Boolean

Indicates whether this operation should bypass Governance-mode restrictions.

Returns:

• (Boolean)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5 ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#expected_bucket_owner ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets] in the *Amazon S3 Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#retention ⇒ Types::ObjectLockRetention

The container element for the Object Retention configuration.

Returns:

• (Types::ObjectLockRetention)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end

#version_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 12212

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end