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



16779
16780
16781
 
// File 'service/s3/api.go', line 16779


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

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

SetBucket sets the Bucket field's value.



16800
16801
16802
16803
 
// File 'service/s3/api.go', line 16800


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.



16813
16814
16815
16816
 
// File 'service/s3/api.go', line 16813


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.



16819
16820
16821
16822
 
// File 'service/s3/api.go', line 16819


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.



16825
16826
16827
16828
 
// File 'service/s3/api.go', line 16825


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.



16831
16832
16833
16834
 
// File 'service/s3/api.go', line 16831


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.



16837
16838
16839
16840
 
// File 'service/s3/api.go', line 16837


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.



16843
16844
16845
16846
 
// File 'service/s3/api.go', line 16843


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.



16849
16850
16851
16852
 
// File 'service/s3/api.go', line 16849


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



16770
16771
16772
 
// File 'service/s3/api.go', line 16770


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.



16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
 
// File 'service/s3/api.go', line 16784


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
}