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 containing the object whose retention settings you want to retrieve.

Returns:

  • (String) 


3476
3477
3478
3479
3480
3481
3482
 
# File 'lib/aws-sdk-s3/types.rb', line 3476

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) 


3476
3477
3478
3479
3480
3481
3482
 
# File 'lib/aws-sdk-s3/types.rb', line 3476

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

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String) 


3476
3477
3478
3479
3480
3481
3482
 
# File 'lib/aws-sdk-s3/types.rb', line 3476

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) 


3476
3477
3478
3479
3480
3481
3482
 
# File 'lib/aws-sdk-s3/types.rb', line 3476

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