Class: Aws::S3::Types::GetObjectLockConfigurationRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::GetObjectLockConfigurationRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass GetObjectLockConfigurationRequest data as a hash:

{
  bucket: "BucketName", # required
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bucket ⇒ String

The bucket whose Object Lock configuration you want to retrieve.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.

Instance Attribute Details

#bucket ⇒ `String`

The bucket whose Object Lock configuration 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 6081

class GetObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :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).