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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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)


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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_algorithmString

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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

Returns:

  • (String)


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ‘403 Forbidden` (access denied).

Returns:

  • (String)


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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

Container element for the legal hold configuration you want to apply to the specified object.



13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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_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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

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

Returns:

  • (String)


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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_idString

The version ID of the object that you want to place a legal hold on.

Returns:

  • (String)


13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
# File 'lib/aws-sdk-s3/types.rb', line 13191

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