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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  expected_bucket_owner: "AccountId",
}

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 action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#bypass_governance_retentionBoolean

Indicates whether this action should bypass Governance-mode restrictions.

Returns:

  • (Boolean)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#checksum_algorithmString

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#content_md5String

The MD5 hash for the request body.

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

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#expected_bucket_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#keyString

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

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  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 Requester Pays Buckets in the Amazon S3 User Guide.

Returns:

  • (String)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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

#retentionTypes::ObjectLockRetention

The container element for the Object Retention configuration.



14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

class PutObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :retention,
  :request_payer,
  :version_id,
  :bypass_governance_retention,
  :content_md5,
  :checksum_algorithm,
  :expected_bucket_owner)
  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)


14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 14005

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