Class: Aws::S3::Types::GetObjectRetentionRequest

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

Overview

Note:

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

{
  bucket: "BucketName", # required
  key: "ObjectKey", # required
  version_id: "ObjectVersionId",
  request_payer: "requester", # accepts requester
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name containing the object whose retention settings you want to retrieve.

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html

Returns:

  • (String) 


4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/aws-sdk-s3/types.rb', line 4873

class GetObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer)
  include Aws::Structure
end

#key ⇒ String

The key name for the object whose retention settings you want to retrieve.

Returns:

  • (String) 


4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/aws-sdk-s3/types.rb', line 4873

class GetObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer)
  include Aws::Structure
end

#request_payer ⇒ String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String) 


4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/aws-sdk-s3/types.rb', line 4873

class GetObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer)
  include Aws::Structure
end

#version_id ⇒ String

The version ID for the object whose retention settings you want to retrieve.

Returns:

  • (String) 


4873
4874
4875
4876
4877
4878
4879
 
# File 'lib/aws-sdk-s3/types.rb', line 4873

class GetObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer)
  include Aws::Structure
end