Class: Aws::S3::Types::PutObjectRetentionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass PutObjectRetentionRequest data as a hash:

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  retention: {
    mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
    retain_until_date: Time.now,
  },
  request_payer: "requester", # accepts requester
  version_id: "ObjectVersionId",
  bypass_governance_retention: false,
  content_md5: "ContentMD5",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

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 using 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.

Returns:

  • (String)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#bypass_governance_retentionBoolean

Indicates whether this operation should bypass Governance-mode restrictions.

Returns:

  • (Boolean)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#content_md5String

The MD5 hash for the request body.

Returns:

  • (String)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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

Returns:

  • (String)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#request_payerString

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.

Returns:

  • (String)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#retentionTypes::ObjectLockRetention

The container element for the Object Retention configuration.



10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end

#version_idString

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

Returns:

  • (String)


10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10496

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5)
  SENSITIVE = []
  include Aws::Structure
end