Class: Aws::S3::Types::PutObjectLegalHoldRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  legal_hold: {
    status: "ON", # accepts ON, OFF
  },
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
  content_md5: "ContentMD5",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket containing the object that you want to place a Legal Hold on.

Returns:

  • (String) 


7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :content_md5)
  include Aws::Structure
end

#content_md5 ⇒ String

The MD5 hash for the request body.

Returns:

  • (String) 


7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :content_md5)
  include Aws::Structure
end

#key ⇒ String

The key name for the object that you want to place a Legal Hold on.

Returns:

  • (String) 


7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :content_md5)
  include Aws::Structure
end

#legal_hold ⇒ Types::ObjectLockLegalHold

Container element for the Legal Hold configuration you want to apply to the specified object.

Returns:



7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :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

Returns:

  • (String) 


7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :content_md5)
  include Aws::Structure
end

#version_id ⇒ String

The version ID of the object that you want to place a Legal Hold on.

Returns:

  • (String) 


7522
7523
7524
7525
7526
7527
7528
7529
7530
 
# File 'lib/aws-sdk-s3/types.rb', line 7522

class PutObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :legal_hold,
  :request_payer,
  :version_id,
  :content_md5)
  include Aws::Structure
end