| Overview |  |
s3_bucket_acl() = private | public_read | public_read_write | authenticated_read | bucket_owner_read | bucket_owner_full_control
s3_bucket_attribute_name() = acl | location | logging | request_payment | versioning | notification
s3_location_constraint() = none | us_west_1 | eu | 'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'ca-central-1' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'eu-north-1' | 'eu-central-1' | 'ap-south-1' | 'ap-southeast-1' | 'ap-southeast-2' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-east-1' | 'me-south-1' | 'sa-east-1'
abort_multipart(BucketName::string(), Key::string(), UploadId::string()) -> ok | {error, any()}
abort_multipart(BucketName::string(), Key::string(), UploadId::string(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> ok | {error, any()}
check_bucket_access(BucketName::string()) -> ok | {error, any()}
check_bucket_access(BucketName::string(), Config::aws_config()) -> ok | {error, any()}
complete_multipart(BucketName::string(), Key::string(), UploadId::string(), ETags::[{integer(), string()}]) -> ok | {error, any()}
complete_multipart(BucketName::string(), Key::string(), UploadId::string(), ETags::[{integer(), string()}], HTTPHeaders::[{string(), string()}], Config::aws_config()) -> ok | {error, any()}
configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok
configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok
configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok
configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer(), Scheme::string()) -> ok
copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string()) -> proplist()
copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string(), Config::proplist() | aws_config()) -> proplist()
copy_object(DestBucketName::string(), DestKeyName::string(), SrcBucketName::string(), SrcKeyName::string(), Options::proplist(), Config::aws_config()) -> proplist()
create_bucket(BucketName::string()) -> ok
create_bucket(BucketName::string(), Config::s3_bucket_acl() | aws_config()) -> ok
create_bucket(BucketName::string(), ACL::s3_bucket_acl(), Config::s3_location_constraint() | aws_config()) -> ok
create_bucket(BucketName::string(), ACL::s3_bucket_acl(), LocationConstraint::s3_location_constraint(), Config::aws_config()) -> ok
create_notification_param_xml(X1::{atom(), term()}, Acc::proplist()) -> proplist()
create_notification_xml(Confs::[proplist()]) -> tuple()
delete_bucket(BucketName::string()) -> ok
delete_bucket(BucketName::string(), Config::aws_config()) -> ok
delete_bucket_encryption(BucketName::string()) -> ok | {error, any()}
S3 API: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketDELETEencryption.html
ok = erlcloud_s3:delete_bucket_encryption("bucket-name").
delete_bucket_encryption(BucketName::string(), Config::aws_config()) -> ok | {error, any()}
delete_bucket_inventory(BucketName::string(), InventoryId::string()) -> ok | {error, Reason::term()}
delete_bucket_inventory(BucketName::string(), InventoryId::string(), Aws_config::aws_config()) -> ok | {error, Reason::term()}
delete_bucket_lifecycle(BucketName::string()) -> ok | {error, Reason::term()}
delete_bucket_lifecycle(BucketName::string(), Aws_config::#aws_config{}) -> ok | {error, Reason::term()}
delete_bucket_tagging(BucketName::string()) -> ok
delete_bucket_tagging(BucketName::string(), Aws_config::aws_config()) -> ok
delete_object(BucketName::string(), Key::string()) -> proplist()
delete_object(BucketName::string(), Key::string(), Config::aws_config()) -> proplist()
delete_object_tagging(BucketName::string(), Key::string()) -> ok
delete_object_tagging(BucketName::string(), Key::string(), Aws_config::aws_config()) -> ok
delete_object_version(BucketName::string(), Key::string(), Version::string()) -> proplist()
delete_object_version(BucketName::string(), Key::string(), Version::string(), Config::aws_config()) -> proplist()
delete_objects_batch(BucketName::string(), KeyList::list()) -> proplist()
delete_objects_batch(BucketName::string(), KeyList::list(), Config::aws_config()) -> proplist()
encode_inventory(Inventory) -> any()
encode_lifecycle(Lifecycle) -> any()
explore_dirstructure(Bucketname::string(), Branches::list(), Accum::list()) -> list()
explore_dirstructure(Bucketname::string(), Tail::list(), Accum::list(), Config::aws_config()) -> list()
get_bucket_and_key(Uri::string()) -> {string(), string()}
get_bucket_attribute(BucketName::string(), AttributeName::s3_bucket_attribute_name()) -> term()
get_bucket_attribute(BucketName::string(), AttributeName::s3_bucket_attribute_name(), Config::aws_config()) -> term()
get_bucket_encryption(BucketName::string()) -> {ok, proplists:proplist()} | {error, any()}
S3 API: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETencryption.html
{ok, [{sse_algorithm, "AES256"},
{kms_master_key_id, undefined}]} = erlcloud_s3:get_bucket_encryption("bucket-name").
get_bucket_encryption(BucketName::string(), Config::aws_config()) -> {ok, proplists:proplist()} | {error, any()}
get_bucket_inventory(BucketName::string(), InventoryId::string()) -> {ok, Result::[term()]} | {error, Reason::term()}
get_bucket_inventory(BucketName::string(), InventoryId::string(), Aws_config::aws_config()) -> {ok, Result::[term()]} | {error, Reason::term()}
get_bucket_lifecycle(BucketName::string()) -> {ok, [proplist()]} | {error, Reason::term()}
get_bucket_lifecycle(BucketName::string(), Config::aws_config()) -> {ok, [proplist()]} | {error, Reason::term()}
get_bucket_notification(XmlElement::#xmlElement{}) -> [proplist()]
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(BucketName::string(), Config::aws_config()) -> {ok, Policy::string()} | {error, Reason::term()}
get_bucket_tagging(BucketName::string()) -> {ok, [{string(), string()}]}
get_bucket_tagging(BucketName::string(), Aws_config::aws_config()) -> {ok, [{string(), string()}]}
get_object(BucketName::string(), Key::string()) -> proplist()
get_object(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()
get_object(BucketName::string(), Key::string(), Options::proplist(), Config::aws_config()) -> proplist()
get_object_acl(BucketName::string(), Key::string()) -> proplist()
get_object_acl(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()
get_object_acl(BucketName::string(), Key::string(), Options::proplist(), Config::aws_config()) -> proplist()
get_object_metadata(BucketName::string(), Key::string()) -> proplist()
get_object_metadata(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()
get_object_metadata(BucketName::string(), Key::string(), Options::proplist(), Config::proplist() | aws_config()) -> proplist()
get_object_tagging(BucketName::string(), Key::string()) -> {ok, [{string(), string()}]}
get_object_tagging(BucketName::string(), Key::string(), Aws_config::aws_config()) -> {ok, [{string(), string()}]}
get_object_torrent(BucketName::string(), Key::string()) -> proplist()
get_object_torrent(BucketName::string(), Key::string(), Config::aws_config()) -> proplist()
get_object_url(BucketName::string(), Key::string()) -> string()
get_object_url(BucketName::string(), Key::string(), Config::aws_config()) -> string()
head_object(BucketName::string(), Key::string()) -> proplist()
head_object(BucketName::string(), Key::string(), Config::proplist() | aws_config()) -> proplist()
head_object(BucketName::string(), Key::string(), Options::proplist(), Config::aws_config()) -> proplist()
list_bucket_inventory(BucketName::string()) -> {ok, Result::[term()]} | {error, Reason::term()}
list_bucket_inventory(BucketName::string(), Aws_config::string() | aws_config()) -> {ok, Result::[term()]} | {error, Reason::term()}
list_bucket_inventory(BucketName::string(), Token::undefined | string(), Aws_config::aws_config()) -> {ok, Result::[term()]} | {error, Reason::term()}
list_buckets() -> proplist()
list_buckets(Config::aws_config()) -> proplist()
list_multipart_uploads(BucketName::string()) -> {ok, proplist()} | {error, any()}
list_multipart_uploads(BucketName::string(), Options::proplist()) -> {ok, proplist()} | {error, any()}
list_multipart_uploads(BucketName::string(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> {ok, proplist()} | {error, any()}
list_object_versions(BucketName::string()) -> proplist()
list_object_versions(BucketName::string(), Config::proplist() | aws_config()) -> proplist()
list_object_versions(BucketName::string(), Options::proplist(), Config::aws_config()) -> proplist()
list_objects(BucketName::string()) -> proplist()
list_objects(BucketName::string(), Config::proplist() | aws_config()) -> proplist()
list_objects(BucketName::string(), Options::proplist(), Config::aws_config()) -> proplist()
make_get_url(Expire_time::integer(), BucketName::string(), Key::string()) -> iolist()
make_get_url(Expire_time::integer(), BucketName::string(), Key::string(), Config::aws_config()) -> iolist()
make_link(Expire_time::integer(), BucketName::string(), Key::string()) -> {integer(), string(), string()}
make_link(Expire_time::integer(), BucketName::string(), Key::string(), Config::aws_config()) -> {integer(), string(), string()}
new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()
new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()
put_bucket_encryption(BucketName::string(), SSEAlgorithm::string()) -> ok | {error, any()}
S3 API: https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html
ok = erlcloud_s3:put_bucket_encryption("bucket-name",
"aws:kms",
"arn:aws:kms:us-east-1:1234/example").
put_bucket_encryption(BucketName::string(), SSEAlgorithm::string(), KMSMasterKeyId::string() | aws_config()) -> ok | {error, any()}
put_bucket_encryption(BucketName::string(), SSEAlgorithm::string(), KMSMasterKeyId::string() | undefined, Config::aws_config()) -> ok | {error, any()}
put_bucket_inventory(BucketName::string(), Inventory::list()) -> ok | {error, Reason::term()}
put_bucket_inventory(BucketName::string(), Inventory::list(), Aws_config::aws_config()) -> ok | {error, Reason::term()}
put_bucket_lifecycle(BucketName::string(), Policy::list() | binary()) -> ok | {error, Reason::term()}
put_bucket_lifecycle(BucketName::string(), Policy::list() | binary(), Config::aws_config()) -> ok | {error, Reason::term()}
put_bucket_policy(BucketName::string(), Policy::binary()) -> ok
put_bucket_policy(BucketName::string(), Policy::binary(), Config::aws_config()) -> ok
put_bucket_tagging(BucketName::string(), TagList::[{string(), string()}]) -> ok
put_bucket_tagging(BucketName::string(), TagList::[{string(), string()}], Aws_config::aws_config()) -> ok
put_object(BucketName::string(), Key::string(), Value::iodata()) -> proplist()
put_object(BucketName::string(), Key::string(), Value::iodata(), Config::proplist() | aws_config()) -> proplist()
put_object(BucketName::string(), Key::string(), Value::iodata(), Options::proplist(), Config::[{string(), string()}] | aws_config()) -> proplist()
put_object(BucketName::string(), Key::string(), Value::iodata(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> proplist()
put_object_tagging(BucketName::string(), Key::string(), TagList::[{string(), string()}]) -> ok
put_object_tagging(BucketName::string(), Key::string(), TagList::[{string(), string()}], Aws_config::aws_config()) -> ok
set_bucket_attribute(BucketName::string(), AttributeName::atom(), Value::term()) -> ok
set_bucket_attribute(BucketName::string(), AttributeName::atom(), Value::term(), Config::aws_config()) -> ok
set_object_acl(BucketName::string(), Key::string(), ACL::proplist()) -> ok
set_object_acl(BucketName::string(), Key::string(), ACL::proplist(), Config::aws_config()) -> ok
start_multipart(BucketName::string(), Key::string()) -> {ok, proplist()} | {error, any()}
start_multipart(BucketName::string(), Key::string(), Options::proplist(), HTTPHeaders::[{string(), string()}], Config::aws_config()) -> {ok, proplist()} | {error, any()}
upload_part(BucketName::string(), Key::string(), UploadId::string(), PartNumber::integer(), Value::iodata()) -> {ok, proplist()} | {error, any()}
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