1S3CL(1)               User Contributed Perl Documentation              S3CL(1)
2
3
4

NAME

6       s3cl - Command line for Amazon s3 cloud storage
7

VERSION

9       version 0.98
10

SYNOPSIS

12       s3cl command [options]
13
14         s3cl buckets
15         s3cl mkbucket --bucket some_bucket_name --jurisdiction [EU|US]
16         s3cl ls <bucket>:[prefix]
17         s3cl cp <bucket>:<key> /path/[filename]
18         s3cl sync <bucket>:[prefix] /path/
19         s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/
20         s3cl rm <bucket>:<key>
21
22        Options:
23          -help            brief help message
24          -man             full documentation
25
26        We take NO responsibility for the costs incured through using
27        this script.
28
29        To run this script, you need to set a pair of environment variables:
30
31        AWS_ACCESS_KEY_ID
32        AWS_ACCESS_KEY_SECRET
33

DESCRIPTION

35       This program gives a command line interface to Amazons s3 storage
36       service. It does not limit the number of requests (which may cost you
37       more money than if you did it a different way!) and each request costs
38       Money (although some costs from EC2 may be $0.0, check latest from
39       Amazon costs page) - we take NO responsibility for your bill.
40

AUTHOR

42       Branislav Zahradník <barney@cpan.org>
43

45       This software is copyright (c) 2021 by Amazon Digital Services, Leon
46       Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover, Branislav
47       Zahradník.
48
49       This is free software; you can redistribute it and/or modify it under
50       the same terms as the Perl 5 programming language system itself.
51

COMMANDS

53       buckets
54           s3cl buckets
55
56           List all buckets for this account.
57
58       mkbucket
59           s3cl mkbucket --bucket sombucketname [--jurisdiction [EU|US]]
60
61           Create a new bucket, optionally specifying what jurisdiction it
62           should be created in.
63
64       ls  s3cl ls <bucket>:[prefix]
65
66           List contents of a bucket, the optional prefix can be partial, in
67           which case all keys matching this as the start of the key name will
68           be returned.  If no prefix is supplied all keys of the bucket will
69           be returned.
70
71       cp  s3cl cp <bucket>:<key> target_file
72
73           s3cl cp <bucket>:<key> target_directory
74
75           Copy a single key from the bucket to the target file, or into the
76           target_directory.
77
78       sync
79           s3cl sync <bucket>:[prefix] target_dir
80
81           Downloads all files matching the prefix into a directory structure
82           replicating that of the prefix and all 'sub-directories'. It will
83           download ALL files - even if already on your local disk:
84
85           http://www.amazon.com/gp/browse.html?node=16427261
86
87             #  Data transfer "in" and "out" refers to transfer into and out
88             #  of Amazon S3.  Data transferred between Amazon EC2 and
89             #  Amazon S3, is free of charge (i.e., $0.00 per GB), except
90             #  data transferred between Amazon EC2 and Amazon S3-Europe,
91             #  which will be charged at regular rates.
92
93       sync_up
94           s3cl sync_up [--acl_short=public-read] <bucket>:[prefix] /path/
95
96           Upload all the files below /path/ to S3, with an optional prefix at
97           the start of the key name. The existing S3 files and meta data are
98           fetched from S3 and the md5 (etag) is compaired to what is on the
99           local disk, files are not upload if the content has not changed.
100
101           Use --acl_short to set access control, options from
102           Net::Amazon::S3::Bucket#set_acl this is only applied when the file
103           is uploaded.
104
105           Each files content-type is worked out using MIME::Types, if this
106           does not match 'text/plain' is used for ASCII text files, otherwise
107           a warning is issued and the file is NOT uploaded.
108
109           Currently this does NOT remove old files from S3, and if there is
110           any change to a file then the entire file will be reuploaded.
111
112       rm  s3cl rm <bucket>:<key>
113
114           Remove a key(file) from the bucket, removing a non-existent file is
115           not classed as an error. Once removed the key (file) can not be
116           restored - so use with care!
117

ABOUT

119       This module contains code modified from Amazon that contains the
120       following notice (which is also applicicable to this code):
121
122         #  This software code is made available "AS IS" without
123         #  warranties of any kind.  You may copy, display, modify and
124         #  redistribute the software code either by itself or as incorporated
125         #  into your code; provided that you do not remove any proprietary
126         #  notices.  Your use of this software code is at your own risk and
127         #  you waive any claim against Amazon Digital Services, Inc. or its
128         #  affiliates with respect to your use of this software code.
129         #  (c) 2006 Amazon Digital Services, Inc. or its affiliates.
130

AUTHOR

132       Leo Lapworth <LLAP@cuckoo.org> - Part of the HinuHinu project
133
134
135
136perl v5.32.1                      2021-03-24                           S3CL(1)
Impressum