Struct: s3.GetBucketLocationInput

import "../ibm-cos-sdk-go/service/s3"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, request.Validator, s3manager.WriterReadFrom

Structure Field Summary collapse

Service Operations collapse

Structure Field Details

Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`

The name of the bucket for which to get the location.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against 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).

Bucket is a required field

ExpectedBucketOwner *string `location:"header" locationName:"x-amz-expected-bucket-owner" type:"string"`

Ignored by COS.

_ struct{} `locationName:"GetBucketLocationRequest" type:"structure"`

Method Details

func (s GetBucketLocationInput) 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”.



12281
12282
12283
// File 'service/s3/api.go', line 12281

func (s GetBucketLocationInput) GoString() string { return s.String() }

func (s *GetBucketLocationInput) SetBucket(v string) *GetBucketLocationInput

SetBucket sets the Bucket field's value.



12302
12303
12304
12305
// File 'service/s3/api.go', line 12302

func (s *GetBucketLocationInput) SetBucket(v string) *GetBucketLocationInput { s.Bucket = &v return s }

func (s *GetBucketLocationInput) SetExpectedBucketOwner(v string) *GetBucketLocationInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.



12315
12316
12317
12318
// File 'service/s3/api.go', line 12315

func (s *GetBucketLocationInput) SetExpectedBucketOwner(v string) *GetBucketLocationInput { s.ExpectedBucketOwner = &v return s }

func (s GetBucketLocationInput) 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”.



12272
12273
12274
// File 'service/s3/api.go', line 12272

func (s GetBucketLocationInput) String() string { return awsutil.Prettify(s) }

func (s *GetBucketLocationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.



12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
// File 'service/s3/api.go', line 12286

func (s *GetBucketLocationInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "GetBucketLocationInput"} if s.Bucket == nil { invalidParams.Add(request.NewErrParamRequired("Bucket")) } if s.Bucket != nil && len(*s.Bucket) < 1 { invalidParams.Add(request.NewErrParamMinLen("Bucket", 1)) } if invalidParams.Len() > 0 { return invalidParams } return nil }