Struct: s3.ListObjectsV2Output
Implemented Interfaces
s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom
Structure Field Summary collapse
-
CommonPrefixes []*CommonPrefix
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
-
Contents []*Object
Metadata about each object returned.
-
ContinuationToken *string
If ContinuationToken was sent with the request, it is included in the response.
-
Delimiter *string
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection.
-
EncodingType *string
Encoding type used by Amazon S3 to encode object key names in the XML response.
-
IsTruncated *bool
Set to false if all of the results were returned.
-
KeyCount *int64
KeyCount is the number of keys returned with this request.
-
MaxKeys *int64
Sets the maximum number of keys returned in the response.
-
Name *string
The bucket name.
-
NextContinuationToken *string
NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed.
-
Prefix *string
Keys that begin with the indicated prefix.
-
RequestCharged *string
If present, indicates that the requester was successfully charged for the request.
-
StartAfter *string
If StartAfter was sent with the request, it is included in the response.
- _ struct{}
Service Operations collapse
-
GoString() string
operation
GoString returns the string representation.
-
SetCommonPrefixes([]*CommonPrefix) *ListObjectsV2Output
operation
SetCommonPrefixes sets the CommonPrefixes field's value.
-
SetContents([]*Object) *ListObjectsV2Output
operation
SetContents sets the Contents field's value.
-
SetContinuationToken(string) *ListObjectsV2Output
operation
SetContinuationToken sets the ContinuationToken field's value.
-
SetDelimiter(string) *ListObjectsV2Output
operation
SetDelimiter sets the Delimiter field's value.
-
SetEncodingType(string) *ListObjectsV2Output
operation
SetEncodingType sets the EncodingType field's value.
-
SetIsTruncated(bool) *ListObjectsV2Output
operation
SetIsTruncated sets the IsTruncated field's value.
-
SetKeyCount(int64) *ListObjectsV2Output
operation
SetKeyCount sets the KeyCount field's value.
-
SetMaxKeys(int64) *ListObjectsV2Output
operation
SetMaxKeys sets the MaxKeys field's value.
-
SetName(string) *ListObjectsV2Output
operation
SetName sets the Name field's value.
-
SetNextContinuationToken(string) *ListObjectsV2Output
operation
SetNextContinuationToken sets the NextContinuationToken field's value.
-
SetPrefix(string) *ListObjectsV2Output
operation
SetPrefix sets the Prefix field's value.
-
SetRequestCharged(string) *ListObjectsV2Output
operation
SetRequestCharged sets the RequestCharged field's value.
-
SetStartAfter(string) *ListObjectsV2Output
operation
SetStartAfter sets the StartAfter field's value.
-
String() string
operation
String returns the string representation.
Structure Field Details
CommonPrefixes []*CommonPrefix
`type:"list" flattened:"true"`
All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.
A response can contain CommonPrefixes only if you specify a delimiter.
CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.
CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
Contents []*Object
`type:"list" flattened:"true"`
Metadata about each object returned.
ContinuationToken *string
`type:"string"`
If ContinuationToken was sent with the request, it is included in the response.
Delimiter *string
`type:"string"`
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
EncodingType *string
`type:"string" enum:"EncodingType"`
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
Delimiter, Prefix, Key, and StartAfter.
IsTruncated *bool
`type:"boolean"`
Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
KeyCount *int64
`type:"integer"`
KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
MaxKeys *int64
`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.
Name *string
`type:"string"`
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 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.
NextContinuationToken *string
`type:"string"`
NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
Prefix *string
`type:"string"`
Keys that begin with the indicated prefix.
RequestCharged *string
`location:"header" locationName:"x-amz-request-charged" type:"string" enum:"RequestCharged"`
If present, indicates that the requester was successfully charged for the request.
StartAfter *string
`type:"string"`
If StartAfter was sent with the request, it is included in the response.
_ struct{}
`type:"structure"`
Method Details
func (s ListObjectsV2Output) 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”.
17281 17282 17283 |
// File 'service/s3/api.go', line 17281
|
func (s *ListObjectsV2Output) SetCommonPrefixes(v []*CommonPrefix) *ListObjectsV2Output
SetCommonPrefixes sets the CommonPrefixes field's value.
17286 17287 17288 17289 |
// File 'service/s3/api.go', line 17286
|
func (s *ListObjectsV2Output) SetContents(v []*Object) *ListObjectsV2Output
SetContents sets the Contents field's value.
17292 17293 17294 17295 |
// File 'service/s3/api.go', line 17292
|
func (s *ListObjectsV2Output) SetContinuationToken(v string) *ListObjectsV2Output
SetContinuationToken sets the ContinuationToken field's value.
17298 17299 17300 17301 |
// File 'service/s3/api.go', line 17298
|
func (s *ListObjectsV2Output) SetDelimiter(v string) *ListObjectsV2Output
SetDelimiter sets the Delimiter field's value.
17304 17305 17306 17307 |
// File 'service/s3/api.go', line 17304
|
func (s *ListObjectsV2Output) SetEncodingType(v string) *ListObjectsV2Output
SetEncodingType sets the EncodingType field's value.
17310 17311 17312 17313 |
// File 'service/s3/api.go', line 17310
|
func (s *ListObjectsV2Output) SetIsTruncated(v bool) *ListObjectsV2Output
SetIsTruncated sets the IsTruncated field's value.
17316 17317 17318 17319 |
// File 'service/s3/api.go', line 17316
|
func (s *ListObjectsV2Output) SetKeyCount(v int64) *ListObjectsV2Output
SetKeyCount sets the KeyCount field's value.
17322 17323 17324 17325 |
// File 'service/s3/api.go', line 17322
|
func (s *ListObjectsV2Output) SetMaxKeys(v int64) *ListObjectsV2Output
SetMaxKeys sets the MaxKeys field's value.
17328 17329 17330 17331 |
// File 'service/s3/api.go', line 17328
|
func (s *ListObjectsV2Output) SetName(v string) *ListObjectsV2Output
SetName sets the Name field's value.
17334 17335 17336 17337 |
// File 'service/s3/api.go', line 17334
|
func (s *ListObjectsV2Output) SetNextContinuationToken(v string) *ListObjectsV2Output
SetNextContinuationToken sets the NextContinuationToken field's value.
17340 17341 17342 17343 |
// File 'service/s3/api.go', line 17340
|
func (s *ListObjectsV2Output) SetPrefix(v string) *ListObjectsV2Output
SetPrefix sets the Prefix field's value.
17346 17347 17348 17349 |
// File 'service/s3/api.go', line 17346
|
func (s *ListObjectsV2Output) SetRequestCharged(v string) *ListObjectsV2Output
SetRequestCharged sets the RequestCharged field's value.
17352 17353 17354 17355 |
// File 'service/s3/api.go', line 17352
|
func (s *ListObjectsV2Output) SetStartAfter(v string) *ListObjectsV2Output
SetStartAfter sets the StartAfter field's value.
17358 17359 17360 17361 |
// File 'service/s3/api.go', line 17358
|
func (s ListObjectsV2Output) 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”.
17272 17273 17274 |
// File 'service/s3/api.go', line 17272
|