Class: Aws::S3Control::Types::S3SetObjectLegalHoldOperation

Inherits:

Struct

• Object
• Struct
• Aws::S3Control::Types::S3SetObjectLegalHoldOperation

Defined in:

(unknown)

Overview

Note:

When passing S3SetObjectLegalHoldOperation as input to an Aws::Client method, you can use a vanilla Hash:

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

Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes each object through to the underlying PutObjectLegalHold API. For more information, see Using S3 Object Lock legal hold with S3 Batch Operations in the Amazon Simple Storage Service Developer Guide.

Returned by:

• JobOperation#s3_put_object_legal_hold

See Also:

• AWS API Documentation

Instance Attribute Summary

• #legal_hold ⇒ Types::S3ObjectLockLegalHold

  Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

Instance Attribute Details

#legal_hold ⇒ Types::S3ObjectLockLegalHold

Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.

Returns:

• (Types::S3ObjectLockLegalHold) —

  Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.