Struct: s3.ListObjectsV2Input

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"`

Bucket name to list.

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

ContinuationToken *string `location:"querystring" locationName:"continuation-token" type:"string"`

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

Delimiter *string `location:"querystring" locationName:"delimiter" type:"string"`

A delimiter is a character that you use to group keys.

EncodingType *string `location:"querystring" locationName:"encoding-type" type:"string" enum:"EncodingType"`

Encoding type used by Amazon S3 to encode object keys in the response.

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

Ignored by COS.

FetchOwner *bool `location:"querystring" locationName:"fetch-owner" type:"boolean"`

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

MaxKeys *int64 `location:"querystring" locationName:"max-keys" type:"integer"`

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Prefix *string `location:"querystring" locationName:"prefix" type:"string"`

Limits the response to keys that begin with the specified prefix.

RequestPayer *string `location:"header" locationName:"x-amz-request-payer" type:"string" enum:"RequestPayer"`

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

StartAfter *string `location:"querystring" locationName:"start-after" type:"string"`

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

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

Method Details

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



17258
17259
17260
 
// File 'service/s3/api.go', line 17258


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

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

SetBucket sets the Bucket field's value.



17279
17280
17281
17282
 
// File 'service/s3/api.go', line 17279


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

func (s *ListObjectsV2Input) SetContinuationToken(v string) *ListObjectsV2Input

SetContinuationToken sets the ContinuationToken field's value.



17292
17293
17294
17295
 
// File 'service/s3/api.go', line 17292


func (s *ListObjectsV2Input) SetContinuationToken(v string) *ListObjectsV2Input {
	s.ContinuationToken = &v
	return s
}

func (s *ListObjectsV2Input) SetDelimiter(v string) *ListObjectsV2Input

SetDelimiter sets the Delimiter field's value.



17298
17299
17300
17301
 
// File 'service/s3/api.go', line 17298


func (s *ListObjectsV2Input) SetDelimiter(v string) *ListObjectsV2Input {
	s.Delimiter = &v
	return s
}

func (s *ListObjectsV2Input) SetEncodingType(v string) *ListObjectsV2Input

SetEncodingType sets the EncodingType field's value.



17304
17305
17306
17307
 
// File 'service/s3/api.go', line 17304


func (s *ListObjectsV2Input) SetEncodingType(v string) *ListObjectsV2Input {
	s.EncodingType = &v
	return s
}

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

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.



17310
17311
17312
17313
 
// File 'service/s3/api.go', line 17310


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

func (s *ListObjectsV2Input) SetFetchOwner(v bool) *ListObjectsV2Input

SetFetchOwner sets the FetchOwner field's value.



17316
17317
17318
17319
 
// File 'service/s3/api.go', line 17316


func (s *ListObjectsV2Input) SetFetchOwner(v bool) *ListObjectsV2Input {
	s.FetchOwner = &v
	return s
}

func (s *ListObjectsV2Input) SetMaxKeys(v int64) *ListObjectsV2Input

SetMaxKeys sets the MaxKeys field's value.



17322
17323
17324
17325
 
// File 'service/s3/api.go', line 17322


func (s *ListObjectsV2Input) SetMaxKeys(v int64) *ListObjectsV2Input {
	s.MaxKeys = &v
	return s
}

func (s *ListObjectsV2Input) SetPrefix(v string) *ListObjectsV2Input

SetPrefix sets the Prefix field's value.



17328
17329
17330
17331
 
// File 'service/s3/api.go', line 17328


func (s *ListObjectsV2Input) SetPrefix(v string) *ListObjectsV2Input {
	s.Prefix = &v
	return s
}

func (s *ListObjectsV2Input) SetRequestPayer(v string) *ListObjectsV2Input

SetRequestPayer sets the RequestPayer field's value.



17334
17335
17336
17337
 
// File 'service/s3/api.go', line 17334


func (s *ListObjectsV2Input) SetRequestPayer(v string) *ListObjectsV2Input {
	s.RequestPayer = &v
	return s
}

func (s *ListObjectsV2Input) SetStartAfter(v string) *ListObjectsV2Input

SetStartAfter sets the StartAfter field's value.



17340
17341
17342
17343
 
// File 'service/s3/api.go', line 17340


func (s *ListObjectsV2Input) SetStartAfter(v string) *ListObjectsV2Input {
	s.StartAfter = &v
	return s
}

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



17249
17250
17251
 
// File 'service/s3/api.go', line 17249


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

func (s *ListObjectsV2Input) Validate() error

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



17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
 
// File 'service/s3/api.go', line 17263


func (s *ListObjectsV2Input) Validate() error {
	invalidParams := request.ErrInvalidParams{Context: "ListObjectsV2Input"}
	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
}