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

Inherits:

Struct

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

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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 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 with 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*.

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

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

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 will fail with an HTTP ‘403 (Access Denied)` error.

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

class GetObjectLockConfigurationRequest < Struct.new(
  :bucket,
  :expected_bucket_owner)
  SENSITIVE = []
  include Aws::Structure
end