Struct: s3.ListMultipartUploadsInput

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

Implemented Interfaces

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

Structure Field Summary collapse

Bucket *string

The name of the bucket to which the multipart upload was initiated.
Delimiter *string

Character you use to group keys.
EncodingType *string

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use.
ExpectedBucketOwner *string

Ignored by COS.
KeyMarker *string

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
MaxUploads *int64

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body.
Prefix *string

Lists in-progress uploads only for those keys that begin with the specified prefix.
UploadIdMarker *string

Together with key-marker, specifies the multipart upload after which listing should begin.
_ struct{}

Service Operations collapse

GoString() string operation

GoString returns the string representation.
SetBucket(string) *ListMultipartUploadsInput operation

SetBucket sets the Bucket field’s value.
SetDelimiter(string) *ListMultipartUploadsInput operation

SetDelimiter sets the Delimiter field’s value.
SetEncodingType(string) *ListMultipartUploadsInput operation

SetEncodingType sets the EncodingType field’s value.
SetExpectedBucketOwner(string) *ListMultipartUploadsInput operation

SetExpectedBucketOwner sets the ExpectedBucketOwner field’s value.
SetKeyMarker(string) *ListMultipartUploadsInput operation

SetKeyMarker sets the KeyMarker field’s value.
SetMaxUploads(int64) *ListMultipartUploadsInput operation

SetMaxUploads sets the MaxUploads field’s value.
SetPrefix(string) *ListMultipartUploadsInput operation

SetPrefix sets the Prefix field’s value.
SetUploadIdMarker(string) *ListMultipartUploadsInput operation

SetUploadIdMarker sets the UploadIdMarker field’s value.
String() string operation

String returns the string representation.
Validate() error operation

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

Structure Field Details

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

The name of the bucket to which the multipart upload was initiated.

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

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don’t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

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.

KeyMarker *string `location:"querystring" locationName:"key-marker" type:"string"`

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

MaxUploads *int64 `location:"querystring" locationName:"max-uploads" type:"integer"`

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

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

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you’d use a folder in a file system.)

UploadIdMarker *string `location:"querystring" locationName:"upload-id-marker" type:"string"`

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

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

Method Details

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



16607
16608
16609

// File 'service/s3/api.go', line 16607

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

func (s ListMultipartUploadsInput) SetBucket(v string) ListMultipartUploadsInput

SetBucket sets the Bucket field’s value.

// File 'service/s3/api.go', line 16628

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

func (s ListMultipartUploadsInput) SetDelimiter(v string) ListMultipartUploadsInput

SetDelimiter sets the Delimiter field’s value.

// File 'service/s3/api.go', line 16641

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

func (s ListMultipartUploadsInput) SetEncodingType(v string) ListMultipartUploadsInput

SetEncodingType sets the EncodingType field’s value.

// File 'service/s3/api.go', line 16647

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

func (s ListMultipartUploadsInput) SetExpectedBucketOwner(v string) ListMultipartUploadsInput

SetExpectedBucketOwner sets the ExpectedBucketOwner field’s value.

// File 'service/s3/api.go', line 16653

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

func (s ListMultipartUploadsInput) SetKeyMarker(v string) ListMultipartUploadsInput

SetKeyMarker sets the KeyMarker field’s value.

// File 'service/s3/api.go', line 16659

func (s *ListMultipartUploadsInput) SetKeyMarker(v string) *ListMultipartUploadsInput {
	s.KeyMarker = &v
	return s
}

func (s ListMultipartUploadsInput) SetMaxUploads(v int64) ListMultipartUploadsInput

SetMaxUploads sets the MaxUploads field’s value.

// File 'service/s3/api.go', line 16665

func (s *ListMultipartUploadsInput) SetMaxUploads(v int64) *ListMultipartUploadsInput {
	s.MaxUploads = &v
	return s
}

func (s ListMultipartUploadsInput) SetPrefix(v string) ListMultipartUploadsInput

SetPrefix sets the Prefix field’s value.

// File 'service/s3/api.go', line 16671

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

func (s ListMultipartUploadsInput) SetUploadIdMarker(v string) ListMultipartUploadsInput

SetUploadIdMarker sets the UploadIdMarker field’s value.

// File 'service/s3/api.go', line 16677

func (s *ListMultipartUploadsInput) SetUploadIdMarker(v string) *ListMultipartUploadsInput {
	s.UploadIdMarker = &v
	return s
}

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



16598
16599
16600

// File 'service/s3/api.go', line 16598

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

func (s *ListMultipartUploadsInput) Validate() error

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

// File 'service/s3/api.go', line 16612

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