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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bucket ⇒ String

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

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

• #expected_bucket_owner ⇒ String

  The account ID of the expected bucket owner.

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

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 in the Amazon S3 User Guide.

When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Returns:

• (String)

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

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

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

Returns:

• (String)

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

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7513

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

#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

• (String)

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

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

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

Returns:

• (String)

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

class ListMultipartUploadsRequest < Struct.new(
  :bucket,
  :delimiter,
  :encoding_type,
  :key_marker,
  :max_uploads,
  :prefix,
  :upload_id_marker,
  :expected_bucket_owner)
  SENSITIVE = []
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7513

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

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

Returns:

• (String)

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

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

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

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