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

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 GetObjectLegalHoldRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The bucket name containing the object whose Legal Hold status 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.

Returns:

  • (String)


4532
4533
4534
4535
4536
4537
4538
4539
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4532

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

#keyString

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

Returns:

  • (String)


4532
4533
4534
4535
4536
4537
4538
4539
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4532

class GetObjectLegalHoldRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer)
  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)


4532
4533
4534
4535
4536
4537
4538
4539
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4532

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

#version_idString

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

Returns:

  • (String)


4532
4533
4534
4535
4536
4537
4538
4539
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4532

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