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
  expected_bucket_owner: "AccountId",
}

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


6026
6027
6028
6029
6030
6031
6032
6033
6034
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6026

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


6026
6027
6028
6029
6030
6031
6032
6033
6034
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6026

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

#keyString

The key name for the object whose legal hold status you want to retrieve.

Returns:

  • (String)


6026
6027
6028
6029
6030
6031
6032
6033
6034
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6026

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


6026
6027
6028
6029
6030
6031
6032
6033
6034
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6026

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

#version_idString

The version ID of the object whose legal hold status you want to retrieve.

Returns:

  • (String)


6026
6027
6028
6029
6030
6031
6032
6033
6034
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6026

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