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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::GetObjectRetentionRequest

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

• #key ⇒ String

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

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

• #version_id ⇒ String

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

Instance Attribute Details

#bucket ⇒ String

The bucket name containing the object whose retention settings 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][1

in the *Amazon S3 User Guide*.

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 6619

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

#expected_bucket_owner ⇒ String

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)

# File 'lib/aws-sdk-s3/types.rb', line 6619

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

#key ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 6619

class GetObjectRetentionRequest < Struct.new(
  :bucket,
  :key,
  :version_id,
  :request_payer,
  :expected_bucket_owner)
  SENSITIVE = []
  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 Requester Pays Buckets] in the *Amazon S3 User Guide*.

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 6619

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

#version_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 6619

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