Class: Aws::S3::Types::PutObjectLegalHoldRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::PutObjectLegalHoldRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The bucket name containing the object that you want to place a legal hold on.
-
#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 place a legal hold on.
-
#legal_hold ⇒ Types::ObjectLockLegalHold
Container element for the legal hold configuration you want to apply to the specified object.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#version_id ⇒ String
The version ID of the object that you want to place a legal hold on.
Instance Attribute Details
#bucket ⇒ String
The bucket name containing the object that you want to place a legal hold on.
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 in the Amazon S3 User Guide.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :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.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :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.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :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).
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#key ⇒ String
The key name for the object that you want to place a legal hold on.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#legal_hold ⇒ Types::ObjectLockLegalHold
Container element for the legal hold configuration you want to apply to the specified object.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :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.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |
#version_id ⇒ String
The version ID of the object that you want to place a legal hold on.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13422 class PutObjectLegalHoldRequest < Struct.new( :bucket, :key, :legal_hold, :request_payer, :version_id, :content_md5, :checksum_algorithm, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |