Module erlcloud_s3

Data Types

s3_bucket_acl()

s3_bucket_acl() = private | public_read | public_read_write | authenticated_read | bucket_owner_read | bucket_owner_full_control

s3_bucket_attribute_name()

s3_bucket_attribute_name() = acl | location | logging | request_payment | versioning | notification

s3_location_constraint()

s3_location_constraint() = none | us_west_1 | eu | '\'us-east-1\'' | '\'us-east-2\'' | '\'us-west-1\'' | '\'eu-west-1\'' | '\'eu-west-2\'' | '\'eu-central-1\'' | '\'ap-south-1\'' | '\'ap-southeast-1\'' | '\'ap-southeast-2\'' | '\'ap-northeast-1\'' | '\'ap-northeast-2\'' | '\'sa-east-1\''

Function Index

abort_multipart/3
abort_multipart/6
check_bucket_access/1
check_bucket_access/2
complete_multipart/4
complete_multipart/6
configure/2
configure/3
configure/4
configure/5
copy_object/4
copy_object/5
copy_object/6
create_bucket/1
create_bucket/2
create_bucket/3
create_bucket/4
create_notification_param_xml/2
create_notification_xml/1
delete_bucket/1
delete_bucket/2
delete_bucket_lifecycle/1
delete_bucket_lifecycle/2
delete_object/2
delete_object/3
delete_object_version/3
delete_object_version/4
delete_objects_batch/2
delete_objects_batch/3
encode_lifecycle/1
explore_dirstructure/3
explore_dirstructure/4
get_bucket_and_key/1
get_bucket_attribute/2
get_bucket_attribute/3
get_bucket_lifecycle/1
get_bucket_lifecycle/2
get_bucket_notification/1
get_bucket_policy/1Get S3 bucket policy JSON object API Document: http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETacl.html.
get_bucket_policy/2
get_object/2
get_object/3
get_object/4
get_object_acl/2
get_object_acl/3
get_object_acl/4
get_object_metadata/2
get_object_metadata/3
get_object_metadata/4
get_object_torrent/2
get_object_torrent/3
get_object_url/2
get_object_url/3
list_buckets/0
list_buckets/1
list_multipart_uploads/1
list_multipart_uploads/2
list_object_versions/1
list_object_versions/2
list_object_versions/3
list_objects/1
list_objects/2
list_objects/3
make_get_url/3
make_get_url/4
make_link/3
make_link/4
new/2
new/3
new/4
put_bucket_lifecycle/2
put_bucket_lifecycle/3
put_bucket_policy/2
put_bucket_policy/3
put_object/3
put_object/4
put_object/5
put_object/6
set_bucket_attribute/3
set_bucket_attribute/4
set_object_acl/3
set_object_acl/4
start_multipart/2
start_multipart/5
upload_part/5
upload_part/7

Function Details

abort_multipart/3

abort_multipart(BucketName::string(), Key::string(), UploadId::string()) -> ok | {error, any()}

abort_multipart/6

abort_multipart(BucketName::string(), Key::string(), UploadId::string(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> ok | {error, any()}

check_bucket_access/1

check_bucket_access(BucketName::string()) -> ok | {error, any()}

check_bucket_access/2

check_bucket_access(BucketName::string(), Config::aws_config()) -> ok | {error, any()}

complete_multipart/4

complete_multipart(BucketName::string(), Key::string(), UploadId::string(), ETags::[{integer(), string()}]) -> {ok, proplist()} | {error, any()}

complete_multipart/6

complete_multipart(BucketName::string(), Key::string(), UploadId::string(), ETags::[{integer(), string()}], HTTPHeaders::[{string(), string()}], Config::aws_config()) -> ok | {error, any()}

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

configure/4

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok

configure/5

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> ok

copy_object/4

copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string()) -> proplist()

copy_object/5

copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string(), Config::proplist() | aws_config()) -> proplist()

copy_object/6

copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string(), Options::proplist(), Config::aws_config()) -> proplist()

create_bucket/1

create_bucket(BucketName::string()) -> ok

create_bucket/2

create_bucket(BucketName::string(), Config::s3_bucket_acl() | aws_config()) -> ok

create_bucket/3

create_bucket(BucketName::string(), ACL::s3_bucket_acl(), Config::s3_location_constraint() | aws_config()) -> ok

create_bucket/4

create_bucket(BucketName::string(), ACL::s3_bucket_acl(), LocationConstraint::s3_location_constraint(), Config::aws_config()) -> ok

create_notification_param_xml/2

create_notification_param_xml(X1::{atom(), term()}, Acc::proplist()) -> proplist()

create_notification_xml/1

create_notification_xml(Confs::proplist()) -> tuple()

delete_bucket/1

delete_bucket(BucketName::string()) -> ok

delete_bucket/2

delete_bucket(BucketName::string(), Config::aws_config()) -> ok

delete_bucket_lifecycle/1

delete_bucket_lifecycle(BucketName::string()) -> ok | {error, Reason::term()}

delete_bucket_lifecycle/2

delete_bucket_lifecycle(BucketName::string(), Aws_config::#aws_config{}) -> ok | {error, Reason::term()}

delete_object/2

delete_object(BucketName::string(), Key::string()) -> proplist()

delete_object/3

delete_object(BucketName::string(), Key::string(), Config::aws_config()) -> proplist()

delete_object_version/3

delete_object_version(BucketName::string(), Key::string(), Version::string()) -> proplist()

delete_object_version/4

delete_object_version(BucketName::string(), Key::string(), Version::string(), Config::aws_config()) -> proplist()

delete_objects_batch/2

delete_objects_batch(Bucket::string(), KeyList::list()) -> no_return()

delete_objects_batch/3

delete_objects_batch(Bucket::string(), KeyList::list(), Config::aws_config()) -> no_return()

encode_lifecycle/1

encode_lifecycle(Lifecycle) -> any()

explore_dirstructure/3

explore_dirstructure(Bucketname::string(), Branches::list(), Accum::list()) -> list()

explore_dirstructure/4

explore_dirstructure(Bucketname::string(), Tail::list(), Result::list(), Config::aws_config()) -> list()

get_bucket_and_key/1

get_bucket_and_key(Uri::string()) -> {string(), string()}

get_bucket_attribute/2

get_bucket_attribute(BucketName::string(), AttributeName::s3_bucket_attribute_name()) -> term()

get_bucket_attribute/3

get_bucket_attribute(BucketName::string(), AttributeName::s3_bucket_attribute_name(), Config::aws_config()) -> term()

get_bucket_lifecycle/1

get_bucket_lifecycle(BucketName::string()) -> ok | {error, Reason::term()}

get_bucket_lifecycle/2

get_bucket_lifecycle(BucketName::string(), Config::aws_config()) -> {ok, Policy::string()} | {error, Reason::term()}

get_bucket_notification/1

get_bucket_notification(XmlElement::#xmlElement{}) -> proplist()

get_bucket_policy/1

get_bucket_policy(BucketName::string()) -> ok | {error, Reason::term()}

Get S3 bucket policy JSON object API Document: http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETacl.html

get_bucket_policy/2

get_bucket_policy(BucketName::string(), Config::aws_config()) -> {ok, Policy::string()} | {error, Reason::term()}

get_object/2

get_object(BucketName::string(), Key::string()) -> proplist()

get_object/3

get_object(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()

get_object/4

get_object(BucketName::string(), Key::string(), Options::proplist(), Config::aws_config()) -> proplist()

get_object_acl/2

get_object_acl(BucketName::string(), Key::string()) -> proplist()

get_object_acl/3

get_object_acl(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()

get_object_acl/4

get_object_acl(BucketName::string(), Key::string(), Options::proplist(), Config::aws_config()) -> proplist()

get_object_metadata/2

get_object_metadata(BucketName::string(), Key::string()) -> proplist()

get_object_metadata/3

get_object_metadata(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()

get_object_metadata/4

get_object_metadata(BucketName::string(), Key::string(), Options::proplist(), Config::proplist() | aws_config()) -> proplist()

get_object_torrent/2

get_object_torrent(BucketName::string(), Key::string()) -> proplist()

get_object_torrent/3

get_object_torrent(BucketName::string(), Key::string(), Config::aws_config()) -> proplist()

get_object_url/2

get_object_url(BucketName::string(), Key::string()) -> string()

get_object_url/3

get_object_url(BucketName::string(), Key::string(), Config::aws_config()) -> string()

list_buckets/0

list_buckets() -> proplist()

list_buckets/1

list_buckets(Config::aws_config()) -> proplist()

list_multipart_uploads/1

list_multipart_uploads(BucketName::string()) -> {ok, proplist()} | {error, any()}

list_multipart_uploads/2

list_multipart_uploads(BucketName::string(), Options::proplist()) -> {ok, proplist()} | {error, any()}

list_object_versions/1

list_object_versions(BucketName::string()) -> proplist()

list_object_versions/2

list_object_versions(BucketName::string(), Config::proplist() | aws_config()) -> proplist()

list_object_versions/3

list_object_versions(BucketName::string(), Options::proplist(), Config::aws_config()) -> proplist()

list_objects/1

list_objects(BucketName::string()) -> proplist()

list_objects/2

list_objects(BucketName::string(), Config::proplist() | aws_config()) -> proplist()

list_objects/3

list_objects(BucketName::string(), Options::proplist(), Config::aws_config()) -> proplist()

make_get_url/3

make_get_url(Expire_time::integer(), BucketName::string(), Key::string()) -> iolist()

make_get_url/4

make_get_url(Expire_time::integer(), BucketName::string(), Key::string(), Config::aws_config()) -> iolist()

make_link/3

make_link(Expire_time::integer(), BucketName::string(), Key::string()) -> {integer(), string(), string()}

make_link/4

make_link(Expire_time::integer(), BucketName::string(), Key::string(), Config::aws_config()) -> {integer(), string(), string()}

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

new/4

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()

put_bucket_lifecycle/2

put_bucket_lifecycle(BucketName::string(), Policy::binary()) -> ok | {error, Reason::term()}

put_bucket_lifecycle/3

put_bucket_lifecycle(BucketName::string(), Policy::list() | binary(), Config::aws_config()) -> ok | {error, Reason::term()}

put_bucket_policy/2

put_bucket_policy(BucketName::string(), Policy::binary()) -> ok

put_bucket_policy/3

put_bucket_policy(BucketName::string(), Policy::binary(), Config::aws_config()) -> ok

put_object/3

put_object(BucketName::string(), Key::string(), Value::iodata()) -> proplist()

put_object/4

put_object(BucketName::string(), Key::string(), Value::iodata(), Config::proplist() | aws_config()) -> proplist()

put_object/5

put_object(BucketName::string(), Key::string(), Value::iodata(), Options::proplist(), Config::[{string(), string()}] | aws_config()) -> proplist()

put_object/6

put_object(BucketName::string(), Key::string(), Value::iodata(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> proplist()

set_bucket_attribute/3

set_bucket_attribute(BucketName::string(), AttributeName::atom(), Value::term()) -> ok

set_bucket_attribute/4

set_bucket_attribute(BucketName::string(), AttributeName::atom(), Value::term(), Config::aws_config()) -> ok

set_object_acl/3

set_object_acl(BucketName::string(), Key::string(), ACL::proplist()) -> ok

set_object_acl/4

set_object_acl(BucketName::string(), Key::string(), ACL::proplist(), Config::aws_config()) -> ok

start_multipart/2

start_multipart(BucketName::string(), Key::string()) -> {ok, proplist()} | {error, any()}

start_multipart/5

start_multipart(BucketName::string(), Key::string(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> {ok, proplist()} | {error, any()}

upload_part/5

upload_part(BucketName::string(), Key::string(), UploadId::string(), PartNumber::integer(), Value::iodata()) -> {ok, proplist()} | {error, any()}

upload_part/7

upload_part(BucketName::string(), Key::string(), UploadId::string(), PartNumber::integer(), Value::iodata(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> {ok, proplist()} | {error, any()}


Generated by EDoc