IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface ListPartsCommandOutput

    The output of ListPartsCommand.

    interface ListPartsCommandOutput {
        AbortDate?: Date;
        AbortRuleId?: string;
        Bucket?: string;
        Key?: string;
        UploadId?: string;
        PartNumberMarker?: string;
        NextPartNumberMarker?: string;
        MaxParts?: number;
        IsTruncated?: boolean;
        Parts?: Part[];
        Initiator?: Initiator;
        Owner?: Owner;
        StorageClass?: StorageClass;
        RequestCharged?: "requester";
        ChecksumAlgorithm?: ChecksumAlgorithm;
        ChecksumType?: ChecksumType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    AbortDate?: Date

    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.

    AbortRuleId?: 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.

    This functionality is not supported for directory buckets.

    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.

    Key?: string

    Object key for which the multipart upload was initiated.

    UploadId?: string

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

    PartNumberMarker?: string

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

    NextPartNumberMarker?: string

    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.

    MaxParts?: number

    Maximum number of parts that were allowed in the response.

    IsTruncated?: 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.

    Parts?: Part[]

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

    Initiator?: 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.

    Owner?: 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.

    StorageClass?: 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.

    RequestCharged?: "requester"

    If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

    This functionality is not supported for directory buckets.

    ChecksumAlgorithm?: ChecksumAlgorithm

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

    ChecksumType?: 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.