Struct: s3.HeadBucketInput
Implemented Interfaces
s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom
Structure Field Summary collapse
-
Bucket *string
The bucket name.
-
ExpectedBucketOwner *string
Ignored by COS.
- _ struct{}
Service Operations collapse
-
GoString() string
operation
GoString returns the string representation.
-
SetBucket(string) *HeadBucketInput
operation
SetBucket sets the Bucket field's value.
-
SetExpectedBucketOwner(string) *HeadBucketInput
operation
SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.
-
String() string
operation
String returns the string representation.
-
Validate() error
operation
Validate inspects the fields of the type to determine if they are valid.
Structure Field Details
Bucket *string
`location:"uri" locationName:"Bucket" type:"string" required:"true"`
The bucket name.
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 (docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) in the Amazon S3 User Guide.
When you use this action 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 (docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList).
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? (docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.
Bucket is a required field
ExpectedBucketOwner *string
`location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`
Ignored by COS.
_ struct{}
`locationName:"HeadBucketRequest" type:"structure"`
Method Details
func (s HeadBucketInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.
14612 14613 14614 |
// File 'service/s3/api.go', line 14612
|
func (s *HeadBucketInput) SetBucket(v string) *HeadBucketInput
SetBucket sets the Bucket field's value.
14633 14634 14635 14636 |
// File 'service/s3/api.go', line 14633
|
func (s *HeadBucketInput) SetExpectedBucketOwner(v string) *HeadBucketInput
SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.
14646 14647 14648 14649 |
// File 'service/s3/api.go', line 14646
|
func (s HeadBucketInput) String() string
String returns the string representation.
API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.
14603 14604 14605 |
// File 'service/s3/api.go', line 14603
|
func (s *HeadBucketInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 |
// File 'service/s3/api.go', line 14617
|