class Aws::S3Control::Types::S3SetObjectLegalHoldOperation

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying `PutObjectLegalHold` API. For more information, see [Using S3 Object Lock legal hold with S3 Batch Operations] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html

@note When making an API call, you may pass S3SetObjectLegalHoldOperation

data as a hash:

    {
      legal_hold: { # required
        status: "OFF", # required, accepts OFF, ON
      },
    }

@!attribute [rw] legal_hold

Contains the Object Lock legal hold status to be applied to all
objects in the Batch Operations job.
@return [Types::S3ObjectLockLegalHold]

@see docs.aws.amazon.com/goto/WebAPI/s3control-2018-08-20/S3SetObjectLegalHoldOperation AWS API Documentation

Constants

SENSITIVE