Class: Aws::S3::Types::HeadBucketRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::HeadBucketRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
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.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style
requests are not supported. Directory bucket names must be unique in
the chosen Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3
(for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket
naming restrictions, see Directory bucket naming rules in the
Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
Object Lambda access points - When you use this API operation
with an Object Lambda access point, provide the alias of the Object
Lambda access point in place of the bucket name. If the Object
Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information
about InvalidAccessPointAliasError
, see List of Error Codes.
S3 on Outposts - When you use this action 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 you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of
the bucket name. For more information about S3 on Outposts ARNs, see
What is S3 on Outposts? in the Amazon S3 User Guide.
7893 7894 7895 7896 7897 7898 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7893 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 account ID that
you provide does not match the actual owner of the bucket, the
request fails with the HTTP status code 403 Forbidden
(access
denied).
7893 7894 7895 7896 7897 7898 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7893 class HeadBucketRequest < Struct.new( :bucket, :expected_bucket_owner) SENSITIVE = [] include Aws::Structure end |