S3Retention
Contains the S3 Object Lock retention mode to be applied to all objects in the
S3 Batch Operations job. If you don't provide Mode and RetainUntilDate
data types in your operation, you will remove the retention from your objects. For more
information, see Using S3 Object Lock retention
with S3 Batch Operations in the Amazon S3 User Guide.
Contents
- EventHold
-
The event hold status to be applied to all objects in the Batch Operations job. Set to
ONto enable an event hold orOFFto disable it.Type: String
Valid Values:
ON | OFFRequired: No
- EventHoldDuration
-
The event hold duration to be applied to all objects in the Batch Operations job. The duration specifies how long the object remains protected after the event hold is released.
Type: S3ObjectLockRetentionEventHoldDuration data type
Required: No
- Mode
-
The Object Lock retention mode to be applied to all objects in the Batch Operations job.
Type: String
Valid Values:
COMPLIANCE | GOVERNANCERequired: No
- RetainUntilDate
-
The date when the applied Object Lock retention will expire on all objects set by the Batch Operations job.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
