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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListMultipartUploadsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Returns:

  • (String)

#delimiterString

Character you use to group keys.

Returns:

  • (String)

    Character you use to group keys.

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

Possible values:

  • url

Returns:

  • (String)

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

#key_markerString

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

Returns:

  • (String)

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

#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)

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

#prefixString

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

Returns:

  • (String)

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

#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)

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

#use_accelerate_endpointBoolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns: