jhn_s3c (jhn_s3c v1.0.0)

View Source

Summary

Types

body/0
bucket/0
class/0
error/0
exception/0
hackney_error/0
headers/0
http_error/0
http_status/0
key/0
mfa_delete/0
opt/0
opts/0
reason/0
status/0
value/0
version_key/0
versioning/0

Functions

count_objects(Bucket)
count_objects(Bucket, NoOfKeysAtTheTime)
create_bucket(Bucket)
create_bucket(Bucket, Opts)
delete_bucket(Bucket)
delete_bucket(Bucket, Opts)
delete_object(Bucket, Key)
delete_object(Bucket, Key, Opts)
delete_objects(Bucket, Keys)
delete_objects(Bucket, Keys, Opts)
get_bucket_versioning(Bucket)
get_bucket_versioning(Bucket, Opts)
get_object(Bucket, Key)
get_object(Bucket, Key, Opts)
head_object(Bucket, Key)
head_object(Bucket, Key, Opts)
list_buckets()
list_buckets(Opts)
list_object_versions(Bucket)
list_object_versions(Bucket, Opts)
list_objects(Bucket)
list_objects(Bucket, Opts)
put_bucket_versioning(Bucket, Status)
put_bucket_versioning(Bucket, Status, Opts)
put_object(Bucket, Key, Value)
put_object(Bucket, Key, Value, Opts)

Types

body/0

-type body() :: binary().

bucket/0

-type bucket() :: binary().

class/0

-type class() :: exit | error | throw.

error/0

-type error() :: {error, http_error() | exception() | hackney_error()}.

exception/0

-type exception() :: {class(), reason(), [tuple()]}.

hackney_error/0

-type hackney_error() :: _.

headers/0

-type headers() :: [{binary(), binary()}].

http_error/0

-type http_error() :: {http_status(), headers(), body()}.

http_status/0

-type http_status() :: integer().

key/0

-type key() :: binary().

mfa_delete/0

-type mfa_delete() :: enabled | disabled.

opt/0

-type opt() ::
          {server, _} |
          {max_keys, integer()} |
          {token, binary()} |
          {key_marker, binary()} |
          {version_id_marker, binary()} |
          {version_id, binary()}.

opts/0

-type opts() :: [opt()].

reason/0

-type reason() :: atom() | {atom(), _}.

status/0

-type status() :: enabled | suspended.

value/0

-type value() :: iodata().

version_key/0

-type version_key() :: #{key := key(), is_latest := boolean(), version_id := binary()}.

versioning/0

-type versioning() :: #{status := status(), mfa_delete => mfa_delete()}.

Functions

count_objects(Bucket)

-spec count_objects(bucket()) -> non_neg_integer() | error().

count_objects(Bucket, NoOfKeysAtTheTime)

-spec count_objects(bucket(), pos_integer()) -> non_neg_integer() | error().

create_bucket(Bucket)

-spec create_bucket(bucket()) -> ok | error().

create_bucket(Bucket, Opts)

-spec create_bucket(bucket(), opts()) -> ok | error().

delete_bucket(Bucket)

-spec delete_bucket(bucket()) -> ok | error().

delete_bucket(Bucket, Opts)

-spec delete_bucket(bucket(), opts()) -> ok | error().

delete_object(Bucket, Key)

-spec delete_object(bucket(), key()) -> ok | error().

delete_object(Bucket, Key, Opts)

-spec delete_object(bucket(), key(), opts()) -> ok | error().

delete_objects(Bucket, Keys)

-spec delete_objects(bucket(), [key() | version_key()]) -> ok | error().

delete_objects(Bucket, Keys, Opts)

-spec delete_objects(bucket(), [key() | version_key()], opts()) -> ok | error().

get_bucket_versioning(Bucket)

-spec get_bucket_versioning(bucket()) -> versioning() | error().

get_bucket_versioning(Bucket, Opts)

-spec get_bucket_versioning(bucket(), opts()) -> versioning() | error().

get_object(Bucket, Key)

-spec get_object(bucket(), key()) -> value() | error().

get_object(Bucket, Key, Opts)

-spec get_object(bucket(), key(), opts()) -> value() | error().

head_object(Bucket, Key)

-spec head_object(bucket(), key()) -> [{binary(), binary()}] | error().

head_object(Bucket, Key, Opts)

-spec head_object(bucket(), key(), opts()) -> [{binary(), binary()}] | error().

list_buckets()

-spec list_buckets() -> [bucket()] | error().

list_buckets(Opts)

-spec list_buckets(opts()) -> [bucket()] | error().

list_object_versions(Bucket)

-spec list_object_versions(bucket()) ->
                              [version_key()] |
                              #{key_marker := _, version_id_marker := _, keys := [version_key()]} |
                              error().

list_object_versions(Bucket, Opts)

-spec list_object_versions(bucket(), opts()) ->
                              binary() |
                              [version_key()] |
                              #{key_marker := _, version_id_marker := _, keys := [version_key()]} |
                              error().

list_objects(Bucket)

-spec list_objects(bucket()) -> [key()] | #{token := _, keys := [key()]} | error().

list_objects(Bucket, Opts)

-spec list_objects(bucket(), opts()) -> [key()] | #{token := _, keys := [key()]} | error().

put_bucket_versioning(Bucket, Status)

-spec put_bucket_versioning(bucket(), status()) -> versioning() | error().

put_bucket_versioning(Bucket, Status, Opts)

-spec put_bucket_versioning(bucket(), status(), opts()) -> versioning() | error().

put_object(Bucket, Key, Value)

-spec put_object(bucket(), key(), value()) -> ok | error().

put_object(Bucket, Key, Value, Opts)

-spec put_object(bucket(), key(), value(), opts()) -> ok | error().