Class: Aws::S3::Types::ListMultipartUploadsOutput

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::ListMultipartUploadsOutput

Includes:

Aws::Structure

Defined in:

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.

• #common_prefixes ⇒ Array<Types::CommonPrefix>

  If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a ‘CommonPrefixes` element.

• #delimiter ⇒ String

  Contains the delimiter you specified in the request.

• #encoding_type ⇒ String

  Encoding type used by Amazon S3 to encode object keys in the response.

• #is_truncated ⇒ Boolean

  Indicates whether the returned list of multipart uploads is truncated.

• #key_marker ⇒ String

  The key at or after which the listing began.

• #max_uploads ⇒ Integer

  Maximum number of multipart uploads that could have been included in the response.

• #next_key_marker ⇒ String

  When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

• #next_upload_id_marker ⇒ String

  When a list is truncated, this element specifies the value that should be used for the ‘upload-id-marker` request parameter in a subsequent request.

• #prefix ⇒ String

  When a prefix is provided in the request, this field contains the specified prefix.

• #request_charged ⇒ String

  If present, indicates that the requester was successfully charged for the request.

• #upload_id_marker ⇒ String

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

• #uploads ⇒ Array<Types::MultipartUpload>

  Container for elements related to a particular multipart upload.

Instance Attribute Details

#bucket ⇒ String

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#common_prefixes ⇒ Array<Types::CommonPrefix>

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a ‘CommonPrefixes` element. The distinct key prefixes are returned in the `Prefix` child element.

<note markdown=“1”> **Directory buckets** - For directory buckets, only prefixes that end in a delimiter (‘/`) are supported.

</note>

Returns:

• (Array<Types::CommonPrefix>)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#delimiter ⇒ String

Contains the delimiter you specified in the request. If you don’t specify a delimiter in your request, this element is absent from the response.

<note markdown=“1”> **Directory buckets** - For directory buckets, ‘/` is the only supported delimiter.

</note>

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#encoding_type ⇒ String

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the ‘encoding-type` request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

‘Delimiter`, `KeyMarker`, `Prefix`, `NextKeyMarker`, `Key`.

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#is_truncated ⇒ Boolean

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

Returns:

• (Boolean)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#key_marker ⇒ String

The key at or after which the listing began.

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#max_uploads ⇒ Integer

Maximum number of multipart uploads that could have been included in the response.

Returns:

• (Integer)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#next_key_marker ⇒ String

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#next_upload_id_marker ⇒ String

When a list is truncated, this element specifies the value that should be used for the ‘upload-id-marker` request parameter in a subsequent request.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

<note markdown=“1”> **Directory buckets** - For directory buckets, only prefixes that end in a delimiter (‘/`) are supported.

</note>

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  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`.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end

#uploads ⇒ Array<Types::MultipartUpload>

Container for elements related to a particular multipart upload. A response can contain zero or more ‘Upload` elements.

Returns:

• (Array<Types::MultipartUpload>)

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

class ListMultipartUploadsOutput < Struct.new(
  :bucket,
  :key_marker,
  :upload_id_marker,
  :next_key_marker,
  :prefix,
  :delimiter,
  :next_upload_id_marker,
  :max_uploads,
  :is_truncated,
  :uploads,
  :common_prefixes,
  :encoding_type,
  :request_charged)
  SENSITIVE = []
  include Aws::Structure
end