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

    Interface ListMultipartUploadsOutput

    interface ListMultipartUploadsOutput {
        Bucket?: string;
        KeyMarker?: string;
        UploadIdMarker?: string;
        NextKeyMarker?: string;
        Prefix?: string;
        Delimiter?: string;
        NextUploadIdMarker?: string;
        MaxUploads?: number;
        IsTruncated?: boolean;
        Uploads?: MultipartUpload[];
        CommonPrefixes?: CommonPrefix[];
        EncodingType?: "url";
        RequestCharged?: "requester";
    }

    Hierarchy (View Summary)

    Index

    Properties

    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.

    KeyMarker?: string

    The key at or after which the listing began.

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

    This functionality is not supported for directory buckets.

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

    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.

    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

    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.

    Directory buckets - For directory buckets, / is the only supported delimiter.

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

    This functionality is not supported for directory buckets.

    MaxUploads?: number

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

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

    Uploads?: MultipartUpload[]

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

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

    Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

    EncodingType?: "url"

    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.

    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.