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

    Interface ListObjectVersionsOutput

    interface ListObjectVersionsOutput {
        IsTruncated?: boolean;
        KeyMarker?: string;
        VersionIdMarker?: string;
        NextKeyMarker?: string;
        NextVersionIdMarker?: string;
        Versions?: ObjectVersion[];
        DeleteMarkers?: DeleteMarkerEntry[];
        Name?: string;
        Prefix?: string;
        Delimiter?: string;
        MaxKeys?: number;
        CommonPrefixes?: CommonPrefix[];
        EncodingType?: "url";
        RequestCharged?: "requester";
    }

    Hierarchy (View Summary)

    Index

    Properties

    IsTruncated?: boolean

    A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

    KeyMarker?: string

    Marks the last key returned in a truncated response.

    VersionIdMarker?: string

    Marks the last version of the key returned in a truncated response.

    NextKeyMarker?: string

    When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

    NextVersionIdMarker?: string

    When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

    Versions?: ObjectVersion[]

    Container for version information.

    DeleteMarkers?: DeleteMarkerEntry[]

    Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.

    Name?: string

    The bucket name.

    Prefix?: string

    Selects objects that start with the value supplied by this parameter.

    Delimiter?: string

    The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

    MaxKeys?: number

    Specifies the maximum number of objects to return.

    CommonPrefixes?: CommonPrefix[]

    All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

    EncodingType?: "url"

    Encoding type used by Amazon S3 to encode object key names in the XML 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:

    KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

    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.