class Aws::S3Control::Types::S3SetObjectRetentionOperation

Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying `PutObjectRetention` API. For more information, see [Using S3 Object Lock retention with S3 Batch Operations] in the *Amazon S3 User Guide*.

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

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

data as a hash:

    {
      bypass_governance_retention: false,
      retention: { # required
        retain_until_date: Time.now,
        mode: "COMPLIANCE", # accepts COMPLIANCE, GOVERNANCE
      },
    }

@!attribute [rw] bypass_governance_retention

Indicates if the action should be applied to objects in the Batch
Operations job even if they have Object Lock ` GOVERNANCE` type in
place.
@return [Boolean]

@!attribute [rw] retention

Contains the Object Lock retention mode to be applied to all objects
in the Batch Operations job. For more information, see [Using S3
Object Lock retention with S3 Batch Operations][1] in the *Amazon S3
User Guide*.

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html
@return [Types::S3Retention]

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

Constants

SENSITIVE