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
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",
}
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket 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.j.
-
#content_md5 ⇒ String
The MD5 hash for the request body.
-
#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 she or he 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 that contains the object you want to apply this Object Retention configuration to.
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#bypass_governance_retention ⇒ Boolean
Indicates whether this operation should bypass Governance-mode restrictions.j
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#content_md5 ⇒ String
The MD5 hash for the request body.
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#key ⇒ String
The key name for the object that you want to apply this Object Retention configuration to.
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#request_payer ⇒ String
Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#retention ⇒ Types::ObjectLockRetention
The container element for the Object Retention configuration.
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |
#version_id ⇒ String
The version ID for the object that you want to apply this Object Retention configuration to.
8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 |
# File 'lib/aws-sdk-s3/types.rb', line 8105 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5) include Aws::Structure end |