Skip to content

ListPartsOutput

Source code in docs_src/capo_s3/types/list_parts_output.py
class ListPartsOutput(TypedDict, closed=True):
    abort_date: NotRequired["capo_s3.types.abort_date.AbortDate"]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config">Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration</a>.</p> <p>The response will also include the <code>x-amz-abort-rule-id</code> header that will provide the ID of the lifecycle configuration rule that defines this action.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    abort_rule_id: NotRequired["capo_s3.types.abort_rule_id.AbortRuleId"]
    """<p>This header is returned along with the <code>x-amz-abort-date</code> header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    bucket: NotRequired["capo_s3.types.bucket_name.BucketName"]
    """<p>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.</p>"""
    key: NotRequired["capo_s3.types.object_key.ObjectKey"]
    """<p>Object key for which the multipart upload was initiated.</p>"""
    upload_id: NotRequired["capo_s3.types.multipart_upload_id.MultipartUploadId"]
    """<p>Upload ID identifying the multipart upload whose parts are being listed.</p>"""
    part_number_marker: NotRequired["capo_s3.types.part_number_marker.PartNumberMarker"]
    """<p>Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.</p>"""
    next_part_number_marker: NotRequired[
        "capo_s3.types.next_part_number_marker.NextPartNumberMarker"
    ]
    """<p>When a list is truncated, this element specifies the last part in the list, as well as the value to use for the <code>part-number-marker</code> request parameter in a subsequent request.</p>"""
    max_parts: NotRequired["capo_s3.types.max_parts.MaxParts"]
    """<p>Maximum number of parts that were allowed in the response.</p>"""
    is_truncated: NotRequired["capo_s3.types.is_truncated.IsTruncated"]
    """<p> 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.</p>"""
    parts: NotRequired["capo_s3.types.parts.Parts"]
    """<p>Container for elements related to a particular part. A response can contain zero or more <code>Part</code> elements.</p>"""
    initiator: NotRequired["capo_s3.types.initiator.Initiator"]
    """<p>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 <code>Owner</code> element. If the initiator is an IAM User, this element provides the user ARN.</p>"""
    owner: NotRequired["capo_s3.types.owner.Owner"]
    """<p>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.</p> <note> <p> <b>Directory buckets</b> - The bucket owner is returned as the object owner for all the parts.</p> </note>"""
    storage_class: NotRequired["capo_s3.types.storage_class.StorageClass"]
    """<p>The class of storage used to store the uploaded object.</p> <note> <p> <b>Directory buckets</b> - Directory buckets only support <code>EXPRESS_ONEZONE</code> (the S3 Express One Zone storage class) in Availability Zones and <code>ONEZONE_IA</code> (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.</p> </note>"""
    request_charged: NotRequired["capo_s3.types.request_charged.RequestCharged"]
    checksum_algorithm: NotRequired[
        "capo_s3.types.checksum_algorithm.ChecksumAlgorithm"
    ]
    """<p>The algorithm that was used to create a checksum of the object.</p>"""
    checksum_type: NotRequired["capo_s3.types.checksum_type.ChecksumType"]
    """<p>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 <code>CreateMultipartUpload</code> request. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html">Checking object integrity in the Amazon S3 User Guide</a>.</p>"""

abort_date instance-attribute

abort_date: NotRequired[AbortDate]

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.

This functionality is not supported for directory buckets.

abort_rule_id instance-attribute

abort_rule_id: NotRequired[AbortRuleId]

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.

This functionality is not supported for directory buckets.

bucket instance-attribute

bucket: NotRequired[BucketName]

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.

checksum_algorithm instance-attribute

checksum_algorithm: NotRequired[ChecksumAlgorithm]

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

checksum_type instance-attribute

checksum_type: NotRequired[ChecksumType]

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.

initiator instance-attribute

initiator: NotRequired[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.

is_truncated instance-attribute

is_truncated: NotRequired[IsTruncated]

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.

key instance-attribute

key: NotRequired[ObjectKey]

Object key for which the multipart upload was initiated.

max_parts instance-attribute

max_parts: NotRequired[MaxParts]

Maximum number of parts that were allowed in the response.

next_part_number_marker instance-attribute

next_part_number_marker: NotRequired[NextPartNumberMarker]

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 instance-attribute

owner: NotRequired[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.

Directory buckets - The bucket owner is returned as the object owner for all the parts.

part_number_marker instance-attribute

part_number_marker: NotRequired[PartNumberMarker]

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

parts instance-attribute

parts: NotRequired[Parts]

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

request_charged instance-attribute

request_charged: NotRequired[RequestCharged]

storage_class instance-attribute

storage_class: NotRequired[StorageClass]

The class of storage used to store the uploaded object.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

upload_id instance-attribute

upload_id: NotRequired[MultipartUploadId]

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