putObjectRetention method

Future<PutObjectRetentionOutput> putObjectRetention({ required String bucket, required String key, bool? bypassGovernanceRetention, String? contentMD5, String? expectedBucketOwner, RequestPayer? requestPayer, ObjectLockRetention? retention, String? versionId, })

Places an Object Retention configuration on an object.

This action is not supported by Amazon S3 on Outposts.

Related Resources

• Locking Objects

Parameter bucket : The bucket name that contains the object you want to apply this Object Retention configuration to.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Parameter key : The key name for the object that you want to apply this Object Retention configuration to.

Parameter bypassGovernanceRetention : Indicates whether this operation should bypass Governance-mode restrictions.

Parameter contentMD5 : The MD5 hash for the request body.

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

Parameter expectedBucketOwner : The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameter retention : The container element for the Object Retention configuration.

Parameter versionId : The version ID for the object that you want to apply this Object Retention configuration to.

Implementation

Future<PutObjectRetentionOutput> putObjectRetention({
  required String bucket,
  required String key,
  bool? bypassGovernanceRetention,
  String? contentMD5,
  String? expectedBucketOwner,
  RequestPayer? requestPayer,
  ObjectLockRetention? retention,
  String? versionId,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(key, 'key');
  _s.validateStringLength(
    'key',
    key,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final headers = <String, String>{
    if (bypassGovernanceRetention != null)
      'x-amz-bypass-governance-retention':
          bypassGovernanceRetention.toString(),
    if (contentMD5 != null) 'Content-MD5': contentMD5.toString(),
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
    if (requestPayer != null) 'x-amz-request-payer': requestPayer.toValue(),
  };
  final $query = <String, List<String>>{
    if (versionId != null) 'versionId': [versionId],
  };
  final $result = await _protocol.sendRaw(
    method: 'PUT',
    requestUri:
        '/${Uri.encodeComponent(bucket)}/${key.split('/').map(Uri.encodeComponent).join('/')}?retention',
    queryParams: $query,
    headers: headers,
    payload: retention?.toXml('Retention'),
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return PutObjectRetentionOutput(
    requestCharged: _s
        .extractHeaderStringValue($result.headers, 'x-amz-request-charged')
        ?.toRequestCharged(),
  );
}