Module Object.List

module Continuation_token : sig ... end
module Delimiter : sig ... end
type options = {
  1. prefix : Object_key.Prefix.t option;
    (*

    Return keys that begin with this prefix.

    *)
  2. delimiter : Delimiter.t option;
    (*

    Group keys using this delimiter, commonly "/".

    *)
  3. max_keys : int option;
    (*

    Maximum number of objects S3 should return in one page.

    *)
  4. start_after : Object_key.t option;
    (*

    Start listing after this key for the first page.

    *)
  5. continuation_token : Continuation_token.t option;
    (*

    Pagination token, usually supplied from a previous page.

    *)
  6. expected_bucket_owner : Account_id.t option;
    (*

    x-amz-expected-bucket-owner.

    *)
}

ListObjectsV2 request options.

type object_summary = {
  1. key : Object_key.t;
    (*

    Object key.

    *)
  2. size : int64 option;
    (*

    Object size in bytes.

    *)
  3. etag : Etag.t option;
    (*

    Object ETag.

    *)
  4. last_modified : Ptime.t option;
    (*

    Last modified timestamp.

    *)
  5. storage_class : Storage_class.t option;
    (*

    Object storage class.

    *)
  6. checksum : Checksum.summary;
    (*

    Checksum summary metadata.

    *)
}

One object summary from a listing page.

type page = {
  1. bucket : Bucket_name.t option;
    (*

    Bucket name echoed by S3.

    *)
  2. prefix : Object_key.Prefix.t option;
    (*

    Prefix applied to this page.

    *)
  3. delimiter : Delimiter.t option;
    (*

    Delimiter applied to this page.

    *)
  4. objects : object_summary list;
    (*

    Object summaries in this page.

    *)
  5. common_prefixes : Object_key.Prefix.t list;
    (*

    Grouped prefixes returned when delimiter is set.

    *)
  6. key_count : int option;
    (*

    Number of keys S3 reports in this page.

    *)
  7. is_truncated : bool;
    (*

    Whether more pages are available.

    *)
  8. continuation_token : Continuation_token.t option;
    (*

    Token used to request this page.

    *)
  9. next_continuation_token : Continuation_token.t option;
    (*

    Token to use for the next page.

    *)
  10. response : Awskit.Response.t;
    (*

    Raw response metadata.

    *)
}

One ListObjectsV2 page.

val default_options : options
val options : ?prefix:Object_key.Prefix.t -> ?delimiter:Delimiter.t -> ?max_keys:int -> ?start_after:Object_key.t -> ?continuation_token:Continuation_token.t -> ?expected_bucket_owner:Account_id.t -> unit -> (options, Awskit.Error.t) Stdlib.result

Build ListObjectsV2 options.

val options_exn : ?prefix:Object_key.Prefix.t -> ?delimiter:Delimiter.t -> ?max_keys:int -> ?start_after:Object_key.t -> ?continuation_token:Continuation_token.t -> ?expected_bucket_owner:Account_id.t -> unit -> options

Like options, but raises on validation failure.