Class: Aws::S3::Types::ListPartsOutput

Inherits:

Struct

Object
Struct
Aws::S3::Types::ListPartsOutput

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#abort_date ⇒ Time

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation.
#abort_rule_id ⇒ String

This header is returned along with the ‘x-amz-abort-date` header.
#bucket ⇒ String

The name of the bucket to which the multipart upload was initiated.
#checksum_algorithm ⇒ String

The algorithm that was used to create a checksum of the object.
#checksum_type ⇒ String

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
#initiator ⇒ Types::Initiator

Container element that identifies who initiated the multipart upload.
#is_truncated ⇒ Boolean

Indicates whether the returned list of parts is truncated.
#key ⇒ String

Object key for which the multipart upload was initiated.
#max_parts ⇒ Integer

Maximum number of parts that were allowed in the response.
#next_part_number_marker ⇒ Integer

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the ‘part-number-marker` request parameter in a subsequent request.
#owner ⇒ Types::Owner

Container element that identifies the object owner, after the object is created.
#part_number_marker ⇒ Integer

Specifies the part after which listing should begin.
#parts ⇒ Array<Types::Part>

Container for elements related to a particular part.
#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.
#storage_class ⇒ String

The class of storage used to store the uploaded object.
#upload_id ⇒ String

Upload ID identifying the multipart upload whose parts are being listed.

Instance Attribute Details

#abort_date ⇒ `Time`

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see [Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration].

The response will also include the ‘x-amz-abort-rule-id` header that will provide the ID of the lifecycle configuration rule that defines this action.

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

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config

Returns:

(Time)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#abort_rule_id ⇒ `String`

This header is returned along with the ‘x-amz-abort-date` header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

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

</note>

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_algorithm ⇒ `String`

The algorithm that was used to create a checksum of the object.

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#checksum_type ⇒ `String`

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in ‘CreateMultipartUpload` request. For more information, see [Checking object integrity in the Amazon S3 User Guide].

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#initiator ⇒ `Types::Initiator`

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the ‘Owner` element. If the initiator is an IAM User, this element provides the user ARN and display name.

Returns:

(Types::Initiator)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#is_truncated ⇒ `Boolean`

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

Returns:

(Boolean)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ `String`

Object key for which the multipart upload was initiated.

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_parts ⇒ `Integer`

Maximum number of parts that were allowed in the response.

Returns:

(Integer)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_part_number_marker ⇒ `Integer`

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the ‘part-number-marker` request parameter in a subsequent request.

Returns:

(Integer)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ `Types::Owner`

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

<note markdown=“1”> **Directory buckets** - The bucket owner is returned as the object owner for all the parts.

</note>

Returns:

(Types::Owner)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#part_number_marker ⇒ `Integer`

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

Returns:

(Integer)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#parts ⇒ `Array<Types::Part>`

Container for elements related to a particular part. A response can contain zero or more ‘Part` elements.

Returns:

(Array<Types::Part>)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  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 11717

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#storage_class ⇒ `String`

The class of storage used to store the uploaded object.

<note markdown=“1”> **Directory buckets** - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

</note>

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

#upload_id ⇒ `String`

Upload ID identifying the multipart upload whose parts are being listed.

Returns:

(String)

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

class ListPartsOutput < Struct.new(
  :abort_date,
  :abort_rule_id,
  :bucket,
  :key,
  :upload_id,
  :part_number_marker,
  :next_part_number_marker,
  :max_parts,
  :is_truncated,
  :parts,
  :initiator,
  :owner,
  :storage_class,
  :request_charged,
  :checksum_algorithm,
  :checksum_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::S3::Types::ListPartsOutput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#abort_date ⇒ Time

#abort_rule_id ⇒ String

#bucket ⇒ String

#checksum_algorithm ⇒ String

#checksum_type ⇒ String

#initiator ⇒ Types::Initiator

#is_truncated ⇒ Boolean

#key ⇒ String

#max_parts ⇒ Integer

#next_part_number_marker ⇒ Integer

#owner ⇒ Types::Owner

#part_number_marker ⇒ Integer

#parts ⇒ Array<Types::Part>

#request_charged ⇒ String

#storage_class ⇒ String

#upload_id ⇒ String

#abort_date ⇒ `Time`

#abort_rule_id ⇒ `String`

#bucket ⇒ `String`

#checksum_algorithm ⇒ `String`

#checksum_type ⇒ `String`

#initiator ⇒ `Types::Initiator`

#is_truncated ⇒ `Boolean`

#key ⇒ `String`

#max_parts ⇒ `Integer`

#next_part_number_marker ⇒ `Integer`

#owner ⇒ `Types::Owner`

#part_number_marker ⇒ `Integer`

#parts ⇒ `Array<Types::Part>`

#request_charged ⇒ `String`

#storage_class ⇒ `String`

#upload_id ⇒ `String`