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",
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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

When using this action 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 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

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

#content_md5String

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.

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP `403 (Access Denied)` error.

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

#keyString

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

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

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


11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

#request_payerString

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 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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

#version_idString

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

Returns:

  • (String)

11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
# File 'lib/aws-sdk-s3/types.rb', line 11749

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