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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Name of the bucket to which the multipart upload was initiated.

When using this API 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 operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

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

#delimiterString

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.

Returns:

  • (String)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  SENSITIVE = []
  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)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

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

#key_markerString

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.

Returns:

  • (String)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  SENSITIVE = []
  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)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

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

#prefixString

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 you'd use a folder in a file system.)

Returns:

  • (String)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker)
  SENSITIVE = []
  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. 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.

Returns:

  • (String)


6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6832

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