View Source jhn_s3c (jhn_s3c v0.3.2)

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)
delete_bucket(Bucket)
delete_object(Bucket, Key)
delete_object(Bucket, Key, Opts)
delete_objects(Bucket, Keys)
get_bucket_versioning(Bucket)
get_object(Bucket, Key)
head_object(Bucket, Key)
list_buckets()
list_object_versions(Bucket)
list_object_versions(Bucket, Opts)
list_objects(Bucket)
list_objects(Bucket, Opts)
put_bucket_versioning(Bucket, Status)
put_object(Bucket, Key, Value)

Types

Link to this type

body/0

View Source 
-type body() :: binary().
Link to this type

bucket/0

View Source 
-type bucket() :: binary().
Link to this type

class/0

View Source 
-type class() :: exit | error | throw.
Link to this type

error/0

View Source 
-type error() :: {error, http_error() | exception() | hackney_error()}.
Link to this type

exception/0

View Source 
-type exception() :: {class(), reason(), [tuple()]}.
Link to this type

hackney_error/0

View Source 
-type hackney_error() :: _.
Link to this type

headers/0

View Source 
-type headers() :: [{binary(), binary()}].
Link to this type

http_error/0

View Source 
-type http_error() :: {http_status(), headers(), body()}.
Link to this type

http_status/0

View Source 
-type http_status() :: integer().
Link to this type

key/0

View Source 
-type key() :: binary().
Link to this type

mfa_delete/0

View Source 
-type mfa_delete() :: enabled | disabled.
Link to this type

opt/0

View Source 
-type opt() ::
          {max_keys, integer()} |
          {token, binary()} |
          {key_marker, binary()} |
          {version_id_marker, binary()} |
          {version_id, binary()}.
Link to this type

opts/0

View Source 
-type opts() :: [opt()].
Link to this type

reason/0

View Source 
-type reason() :: atom() | {atom(), _}.
Link to this type

status/0

View Source 
-type status() :: enabled | suspended.
Link to this type

value/0

View Source 
-type value() :: iodata().
Link to this type

version_key/0

View Source 
-type version_key() :: #{key := key(), is_latest := boolean(), version_id := binary()}.
Link to this type

versioning/0

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

Functions

Link to this function

count_objects(Bucket)

View Source 
-spec count_objects(bucket()) -> non_neg_integer() | error().
Link to this function

count_objects(Bucket, NoOfKeysAtTheTime)

View Source 
-spec count_objects(bucket(), pos_integer()) -> non_neg_integer() | error().
Link to this function

create_bucket(Bucket)

View Source 
-spec create_bucket(bucket()) -> ok | error().
Link to this function

delete_bucket(Bucket)

View Source 
-spec delete_bucket(bucket()) -> ok | error().
Link to this function

delete_object(Bucket, Key)

View Source 
-spec delete_object(bucket(), key()) -> ok | error().
Link to this function

delete_object(Bucket, Key, Opts)

View Source 
-spec delete_object(bucket(), key(), opts()) -> ok | error().
Link to this function

delete_objects(Bucket, Keys)

View Source 
-spec delete_objects(bucket(), [key() | version_key()]) -> ok | error().
Link to this function

get_bucket_versioning(Bucket)

View Source 
-spec get_bucket_versioning(bucket()) -> versioning() | error().
Link to this function

get_object(Bucket, Key)

View Source 
-spec get_object(bucket(), key()) -> value() | error().
Link to this function

head_object(Bucket, Key)

View Source 
-spec head_object(bucket(), key()) -> [{binary(), binary()}] | error().
Link to this function

list_buckets()

View Source 
-spec list_buckets() -> [bucket()] | error().
Link to this function

list_object_versions(Bucket)

View Source 
-spec list_object_versions(bucket()) ->
                              [version_key()] |
                              #{key_marker := _, version_id_marker := _, keys := [version_key()]} |
                              error().
Link to this function

list_object_versions(Bucket, Opts)

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

list_objects(Bucket)

View Source 
-spec list_objects(bucket()) -> [key()] | #{token := _, keys := [key()]} | error().
Link to this function

list_objects(Bucket, Opts)

View Source 
-spec list_objects(bucket(), opts()) -> [key()] | #{token := _, keys := [key()]} | error().
Link to this function

put_bucket_versioning(Bucket, Status)

View Source 
-spec put_bucket_versioning(bucket(), status()) -> versioning() | error().
Link to this function

put_object(Bucket, Key, Value)

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