You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::S3::Types::ListMultipartUploadsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass ListMultipartUploadsRequest data as a hash:

{
  bucket: "BucketName", # required
  delimiter: "Delimiter",
  encoding_type: "url", # accepts url
  key_marker: "KeyMarker",
  max_uploads: 1,
  prefix: "Prefix",
  upload_id_marker: "UploadIdMarker",
}

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#delimiterString

Character you use to group keys.

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#encoding_typeString

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, 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.

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#key_markerString

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

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#max_uploadsInteger

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.

Returns:

  • (Integer)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#prefixString

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

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end

#upload_id_markerString

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.

Returns:

  • (String)


4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4495

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  include Aws::Structure
end