.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.11.
.TH S4CMD.PY "1" "September 2019" "s4cmd.py 2.0.1" "User Commands"
.SH NAME
s4cmd.py \- Super Amazon S3 command line tool
.SH SYNOPSIS
.B s4cmd.py
[\fI\,options\/\fR]
.SH DESCRIPTION
S4cmd is a command-line utility for accessing Amazon S3, inspired by s3cmd.
It is intended as an alternative to s3cmd for enhanced performance and for
large files, and with a number of additional features and fixes.
In general, it strives to be compatible with the most common usage scenarios
for s3cmd. It does not offer exact drop-in compatibility, due to a number of
corner cases where different behavior seems preferable, or for bugfixes.
.PP
Super S3 command line tool. Version 2.1.0
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
print out version of s4cmd
.TP
\fB\-p\fR S3CFG, \fB\-\-config\fR=\fI\,S3CFG\/\fR
path to s3cfg config file
.TP
\fB\-\-access\-key\fR=\fI\,ACCESS_KEY\/\fR
use access_key for connection to S3
.TP
\fB\-\-secret\-key\fR=\fI\,SECRET_KEY\/\fR
use security key for connection to S3
.TP
\fB\-f\fR, \fB\-\-force\fR
force overwrite files when download or upload
.TP
\fB\-r\fR, \fB\-\-recursive\fR
recursively checking subdirectories
.TP
\fB\-s\fR, \fB\-\-sync\-check\fR
check file md5 before download or upload
.TP
\fB\-n\fR, \fB\-\-dry\-run\fR
trial run without actual download or upload
.TP
\fB\-t\fR RETRY, \fB\-\-retry\fR=\fI\,RETRY\/\fR
number of retries before giving up
.TP
\fB\-\-retry\-delay\fR=\fI\,RETRY_DELAY\/\fR
seconds to sleep between retries
.TP
\fB\-c\fR NUM_THREADS, \fB\-\-num\-threads\fR=\fI\,NUM_THREADS\/\fR
number of concurrent threads
.TP
\fB\-d\fR, \fB\-\-show\-directory\fR
show directory instead of its content
.TP
\fB\-\-ignore\-empty\-source\fR
ignore empty source from s3
.TP
\fB\-\-endpoint\-url\fR=\fI\,ENDPOINT_URL\/\fR
configure boto3 to use a different s3 endpoint
.TP
\fB\-\-use\-ssl\fR
(obsolete) use SSL connection to S3
.TP
\fB\-\-verbose\fR
verbose output
.TP
\fB\-\-debug\fR
debug output
.TP
\fB\-\-validate\fR
(obsolete) validate lookup operation
.TP
\fB\-D\fR, \fB\-\-delete\-removed\fR
delete remote files that do not exist in source after
sync
.TP
\fB\-\-multipart\-split\-size\fR=\fI\,MULTIPART_SPLIT_SIZE\/\fR
size in bytes to split multipart transfers
.TP
\fB\-\-max\-singlepart\-download\-size\fR=\fI\,MAX_SINGLEPART_DOWNLOAD_SIZE\/\fR
files with size (in bytes) greater than this will be
downloaded in multipart transfers
.TP
\fB\-\-max\-singlepart\-upload\-size\fR=\fI\,MAX_SINGLEPART_UPLOAD_SIZE\/\fR
files with size (in bytes) greater than this will be
uploaded in multipart transfers
.TP
\fB\-\-max\-singlepart\-copy\-size\fR=\fI\,MAX_SINGLEPART_COPY_SIZE\/\fR
files with size (in bytes) greater than this will be
copied in multipart transfers
.TP
\fB\-\-batch\-delete\-size\fR=\fI\,BATCH_DELETE_SIZE\/\fR
Number of files (<1000) to be combined in batch
delete.
.TP
\fB\-\-last\-modified\-before\fR=\fI\,LAST_MODIFIED_BEFORE\/\fR
Condition on files where their last modified dates are
before given parameter.
.TP
\fB\-\-last\-modified\-after\fR=\fI\,LAST_MODIFIED_AFTER\/\fR
Condition on files where their last modified dates are
after given parameter.
.TP
\fB\-\-API\-ACL\fR=\fI\,ACL\/\fR
The canned ACL to apply to the object.
.TP
\fB\-\-API\-CacheControl\fR=\fI\,CACHECONTROL\/\fR
Specifies caching behavior along the request/reply
chain.
.TP
\fB\-\-API\-ContentDisposition\fR=\fI\,CONTENTDISPOSITION\/\fR
Specifies presentational information for the object.
.TP
\fB\-\-API\-ContentEncoding\fR=\fI\,CONTENTENCODING\/\fR
Specifies what content encodings have been applied to
the object and thus what decoding mechanisms must be
applied to obtain the media\-type referenced by the
Content\-Type header field.
.TP
\fB\-\-API\-ContentLanguage\fR=\fI\,CONTENTLANGUAGE\/\fR
The language the content is in.
.TP
\fB\-\-API\-ContentMD5\fR=\fI\,CONTENTMD5\/\fR
The base64\-encoded 128\-bit MD5 digest of the part
data.
.TP
\fB\-\-API\-ContentType\fR=\fI\,CONTENTTYPE\/\fR
A standard MIME type describing the format of the
object data.
.TP
\fB\-\-API\-CopySourceIfMatch\fR=\fI\,COPYSOURCEIFMATCH\/\fR
Copies the object if its entity tag (ETag) matches the
specified tag.
.TP
\fB\-\-API\-CopySourceIfModifiedSince\fR=\fI\,COPYSOURCEIFMODIFIEDSINCE\/\fR
Copies the object if it has been modified since the
specified time.
.TP
\fB\-\-API\-CopySourceIfNoneMatch\fR=\fI\,COPYSOURCEIFNONEMATCH\/\fR
Copies the object if its entity tag (ETag) is
different than the specified ETag.
.TP
\fB\-\-API\-CopySourceIfUnmodifiedSince\fR=\fI\,COPYSOURCEIFUNMODIFIEDSINCE\/\fR
Copies the object if it hasn't been modified since the
specified time.
.TP
\fB\-\-API\-CopySourceRange\fR=\fI\,COPYSOURCERANGE\/\fR
The range of bytes to copy from the source object. The
range value must use the form bytes=first\-last, where
the first and last are the zero\-based byte offsets to
copy. For example, bytes=0\-9 indicates that you want
to copy the first ten bytes of the source. You can
copy a range only if the source object is greater than
5 GB.
.TP
\fB\-\-API\-CopySourceSSECustomerAlgorithm\fR=\fI\,COPYSOURCESSECUSTOMERALGORITHM\/\fR
Specifies the algorithm to use when decrypting the
source object (e.g., AES256).
.TP
\fB\-\-API\-CopySourceSSECustomerKeyMD5\fR=\fI\,COPYSOURCESSECUSTOMERKEYMD5\/\fR
Specifies the 128\-bit MD5 digest of the encryption key
according to RFC 1321. Amazon S3 uses this header for
a message integrity check to ensure the encryption key
was transmitted without error. Please note that this
parameter is automatically populated if it is not
provided. Including this parameter is not required
.TP
\fB\-\-API\-CopySourceSSECustomerKey\fR=\fI\,COPYSOURCESSECUSTOMERKEY\/\fR
Specifies the customer\-provided encryption key for
Amazon S3 to use to decrypt the source object. The
encryption key provided in this header must be one
that was used when the source object was created.
.TP
\fB\-\-API\-ETag\fR=\fI\,ETAG\/\fR
Entity tag returned when the part was uploaded.
.TP
\fB\-\-API\-Expires\fR=\fI\,EXPIRES\/\fR
The date and time at which the object is no longer
cacheable.
.TP
\fB\-\-API\-GrantFullControl\fR=\fI\,GRANTFULLCONTROL\/\fR
Gives the grantee READ, READ_ACP, and WRITE_ACP
permissions on the object.
.TP
\fB\-\-API\-GrantReadACP\fR=\fI\,GRANTREADACP\/\fR
Allows grantee to read the object ACL.
.TP
\fB\-\-API\-GrantRead\fR=\fI\,GRANTREAD\/\fR
Allows grantee to read the object data and its
metadata.
.TP
\fB\-\-API\-GrantWriteACP\fR=\fI\,GRANTWRITEACP\/\fR
Allows grantee to write the ACL for the applicable
object.
.TP
\fB\-\-API\-IfMatch\fR=\fI\,IFMATCH\/\fR
Return the object only if its entity tag (ETag) is the
same as the one specified, otherwise return a 412
(precondition failed).
.TP
\fB\-\-API\-IfModifiedSince\fR=\fI\,IFMODIFIEDSINCE\/\fR
Return the object only if it has been modified since
the specified time, otherwise return a 304 (not
modified).
.TP
\fB\-\-API\-IfNoneMatch\fR=\fI\,IFNONEMATCH\/\fR
Return the object only if its entity tag (ETag) is
different from the one specified, otherwise return a
304 (not modified).
.TP
\fB\-\-API\-IfUnmodifiedSince\fR=\fI\,IFUNMODIFIEDSINCE\/\fR
Return the object only if it has not been modified
since the specified time, otherwise return a 412
(precondition failed).
.TP
\fB\-\-API\-Metadata\fR=\fI\,METADATA\/\fR
A map (in json string) of metadata to store with the
object in S3
.TP
\fB\-\-API\-MetadataDirective\fR=\fI\,METADATADIRECTIVE\/\fR
Specifies whether the metadata is copied from the
source object or replaced with metadata provided in
the request.
.TP
\fB\-\-API\-MFA\fR=\fI\,MFA\/\fR
The concatenation of the authentication device's
serial number, a space, and the value that is
displayed on your authentication device.
.TP
\fB\-\-API\-RequestPayer\fR=\fI\,REQUESTPAYER\/\fR
Confirms that the requester knows that she or he will
be charged for the request. Bucket owners need not
specify this parameter in their requests.
Documentation on downloading objects from requester
pays buckets can be found at http://docs.aws.amazon.co
m/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.ht
ml
.TP
\fB\-\-API\-ServerSideEncryption\fR=\fI\,SERVERSIDEENCRYPTION\/\fR
The Server\-side encryption algorithm used when storing
this object in S3 (e.g., AES256, aws:kms).
.TP
\fB\-\-API\-SSECustomerAlgorithm\fR=\fI\,SSECUSTOMERALGORITHM\/\fR
Specifies the algorithm to use to when encrypting the
object (e.g., AES256).
.TP
\fB\-\-API\-SSECustomerKeyMD5\fR=\fI\,SSECUSTOMERKEYMD5\/\fR
Specifies the 128\-bit MD5 digest of the encryption key
according to RFC 1321. Amazon S3 uses this header for
a message integrity check to ensure the encryption key
was transmitted without error. Please note that this
parameter is automatically populated if it is not
provided. Including this parameter is not required
.TP
\fB\-\-API\-SSECustomerKey\fR=\fI\,SSECUSTOMERKEY\/\fR
Specifies the customer\-provided encryption key for
Amazon S3 to use in encrypting data. This value is
used to store the object and then it is discarded;
Amazon does not store the encryption key. The key must
be appropriate for use with the algorithm specified in
the x\-amz\-server\-side\-encryption\-customer\-algorithm
header.
.TP
\fB\-\-API\-SSEKMSKeyId\fR=\fI\,SSEKMSKEYID\/\fR
Specifies the AWS KMS key ID to use for object
encryption. All GET and PUT requests for an object
protected by AWS KMS will fail if not made via SSL or
using SigV4. Documentation on configuring any of the
officially supported AWS SDKs and CLI can be found at
http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAW
SSDK.html#specify\-signature\-version
.TP
\fB\-\-API\-StorageClass\fR=\fI\,STORAGECLASS\/\fR
The type of storage to use for the object. Defaults to
\&'STANDARD'.
.TP
\fB\-\-API\-VersionId\fR=\fI\,VERSIONID\/\fR
VersionId used to reference a specific version of the
object.
.TP
\fB\-\-API\-WebsiteRedirectLocation\fR=\fI\,WEBSITEREDIRECTLOCATION\/\fR
If the bucket is configured as a website, redirects
requests for this object to another object in the same
bucket or to an external URL. Amazon S3 stores the
value of this header in the object metadata.
.SH "REPORTING BUGS"
Please report bugs with s4cmd itself to the authors' GitHub issue tracker:
https://github.com/bloomreach/s4cmd/issues
.SH COPYRIGHT
2012-2016 BloomReach, Inc.