Class: Aws::S3::Types::GetObjectLegalHoldRequest

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 GetObjectLegalHoldRequest 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 Legal Hold status you want to retrieve.

Returns:

  • (String) 


3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/aws-sdk-s3/types.rb', line 3061

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

#key ⇒ String

The key name for the object whose Legal Hold status you want to retrieve.

Returns:

  • (String) 


3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/aws-sdk-s3/types.rb', line 3061

class GetObjectLegalHoldRequest < 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) 


3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/aws-sdk-s3/types.rb', line 3061

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

#version_id ⇒ String

The version ID of the object whose Legal Hold status you want to retrieve.

Returns:

  • (String) 


3061
3062
3063
3064
3065
3066
3067
 
# File 'lib/aws-sdk-s3/types.rb', line 3061

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