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 name containing the object that you want to place a Legal Hold on.

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 using 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) 


9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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) 


9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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) 


9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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:



9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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 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) 


9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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) 


9660
9661
9662
9663
9664
9665
9666
9667
9668
 
# File 'lib/aws-sdk-s3/types.rb', line 9660

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