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
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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 action should bypass Governance-mode restrictions.
-
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object when you use the SDK.
-
#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.
**Access points** - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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][1
-
in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#bypass_governance_retention ⇒ Boolean
Indicates whether this action should bypass Governance-mode restrictions.
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don’t use the SDK. When you send this header, there must be a corresponding ‘x-amz-checksum` or `x-amz-trailer` header sent. Otherwise, Amazon S3 fails the request with the HTTP status code `400 Bad Request`. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.
If you provide an individual checksum, Amazon S3 ignores any provided ‘ChecksumAlgorithm` parameter.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#content_md5 ⇒ String
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code ‘403 Forbidden` (access denied).
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :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.
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see [Downloading Objects in Requester Pays Buckets] in the *Amazon S3 User Guide*.
<note markdown=“1”> This functionality is not supported for directory buckets.
</note>
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#retention ⇒ Types::ObjectLockRetention
The container element for the Object Retention configuration.
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :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.
15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 |
# File 'lib/aws-sdk-s3/types.rb', line 15299 class PutObjectRetentionRequest < Struct.new( :bucket, :key, :retention, :request_payer, :version_id, :bypass_governance_retention, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |