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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListMultipartUploadsRequest

Includes:

Aws::Structure

Defined in:

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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bucket ⇒ String
• #delimiter ⇒ String

  Character you use to group keys.

• #encoding_type ⇒ String

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

• #key_marker ⇒ String

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

• #max_uploads ⇒ Integer

  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.

• #upload_id_marker ⇒ String

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

Instance Attribute Details

#bucket ⇒ String

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#delimiter ⇒ String

Character you use to group keys.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#encoding_type ⇒ String

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)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#key_marker ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#max_uploads ⇒ 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.

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#prefix ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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

#upload_id_marker ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 4979

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