Struct: s3.ListObjectsInput

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 containing the objects.

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

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

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

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

Ignored by COS.

Marker *string `location:"querystring" locationName:"marker" type:"string"`

Specifies the key to start with when listing objects in a bucket.

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. Bucket owners need not specify this parameter in their requests.

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

Method Details

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



16949
16950
16951
 
// File 'service/s3/api.go', line 16949


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

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

SetBucket sets the Bucket field's value.



16970
16971
16972
16973
 
// File 'service/s3/api.go', line 16970


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

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

SetDelimiter sets the Delimiter field's value.



16983
16984
16985
16986
 
// File 'service/s3/api.go', line 16983


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

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

SetEncodingType sets the EncodingType field's value.



16989
16990
16991
16992
 
// File 'service/s3/api.go', line 16989


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

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

SetExpectedBucketOwner sets the ExpectedBucketOwner field's value.



16995
16996
16997
16998
 
// File 'service/s3/api.go', line 16995


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

func (s *ListObjectsInput) SetMarker(v string) *ListObjectsInput

SetMarker sets the Marker field's value.



17001
17002
17003
17004
 
// File 'service/s3/api.go', line 17001


func (s *ListObjectsInput) SetMarker(v string) *ListObjectsInput {
	s.Marker = &v
	return s
}

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

SetMaxKeys sets the MaxKeys field's value.



17007
17008
17009
17010
 
// File 'service/s3/api.go', line 17007


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

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

SetPrefix sets the Prefix field's value.



17013
17014
17015
17016
 
// File 'service/s3/api.go', line 17013


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

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

SetRequestPayer sets the RequestPayer field's value.



17019
17020
17021
17022
 
// File 'service/s3/api.go', line 17019


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

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



16940
16941
16942
 
// File 'service/s3/api.go', line 16940


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

func (s *ListObjectsInput) Validate() error

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



16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
 
// File 'service/s3/api.go', line 16954


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