Class: Aws::S3::Types::HeadBucketRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::HeadBucketRequest

show all

Includes:: Aws::Structure

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

Overview

Note:

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

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#bucket ⇒ String

The bucket name.
#expected_bucket_owner ⇒ String

The account id of the expected bucket owner.

Instance Attribute Details

#bucket ⇒ `String`

The bucket name.

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*.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see [Using S3 on Outposts] in the *Amazon Simple Storage Service Developer Guide*.

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

Returns:

(String)

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

class HeadBucketRequest < 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.