S3 / Client / extend_object_retention

extend_object_retention#

S3.Client.extend_object_retention(**kwargs)#

This implementation of the POST operation uses the extendRetention sub-resource to extend the retention period of a protected object in a protected vault.

See also: AWS API Documentation

Request Syntax

response = client.extend_object_retention(
    Bucket='string',
    Key='string',
    AdditionalRetentionPeriod=123,
    ExtendRetentionFromCurrentTime=123,
    NewRetentionExpirationDate=datetime(2015, 1, 1),
    NewRetentionPeriod=123
)
Parameters:

  • Bucket (string) – [REQUIRED]

  • Key (string) – [REQUIRED]

  • AdditionalRetentionPeriod (integer) – Additional time, in seconds, to add to the existing retention period for the object. If this field and New-Retention-Time and/or New-Retention-Expiration-Date are specified, a 400 error will be returned. If none of the Request Headers are specified, a 400 error will be returned to the user. The retention period of an object may be extended up to bucket maximum retention period from the time of the request.

  • ExtendRetentionFromCurrentTime (integer) – Retention Period in seconds. The Retention will be enforced from the object creation time until current time + the value in this header. This value has to be within the ranges defined for the bucket. If this field and Additional-Retention-Period and/or New-Retention-Period and/or New-Retentiion-Expiration-Date are specified, a 400 error will be returned. If none of the Request Headers are specified, a 400 error will be returned to the user. The retention period of an object may be extended up to bucket maximum retention period from the time of the request.

  • NewRetentionExpirationDate (datetime) – A new retention date to use for the object in place of the existing retention date. If this value is less than the existing value stored for the object, a 400 error will be returned. If this field and Additional-Retention-Period and/or New-Retention-Period and/or Extend-Retention-From-Current-Time are specified, a 400 error will be returned. If none of the Request Headers are specified, a 400 error will be returned to the user. The retention period of an object may be extended up to bucket maximum retention period from the time of the request.

  • NewRetentionPeriod (integer) – Retention period, in seconds, to use for the object in place of the existing retention period stored for the object. If this value is less than the existing value stored for the object, a 400 error will be returned. If this field and Additional-Retention-Period and/or New-Retention-Expiration-Date and/or Extend-Retention-From-Current-Time are specified, a 400 error will be returned. If none of the Request Headers are specified, a 400 error will be returned to the user. The retention period of an object may be extended up to bucket maximum retention period from the time of the request.

Returns:

None