<a id="cli-aws-s3-sync"></a>

# sync

## Description

Syncs directories and S3 prefixes. Recursively copies new and updated files from the source directory to the destination. Only creates folders in the destination if they contain one or more files.

## Synopsis

```
  sync
<LocalPath> <S3Uri> or <S3Uri> <LocalPath> or <S3Uri> <S3Uri>
[--dryrun]
[--quiet]
[--include <value>]
[--exclude <value>]
[--acl <value>]
[--follow-symlinks | --no-follow-symlinks]
[--no-guess-mime-type]
[--sse <value>]
[--sse-c <value>]
[--sse-c-key <value>]
[--sse-kms-key-id <value>]
[--sse-c-copy-source <value>]
[--sse-c-copy-source-key <value>]
[--storage-class <value>]
[--tags <key> <value>]
[--grants <value> [<value>...]]
[--website-redirect <value>]
[--content-type <value>]
[--cache-control <value>]
[--content-disposition <value>]
[--content-encoding <value>]
[--content-language <value>]
[--expires <value>]
[--source-region <value>]
[--only-show-errors]
[--no-progress]
[--progress-frequency <value>]
[--progress-multiline]
[--page-size <value>]
[--ignore-glacier-warnings]
[--force-glacier-transfer]
[--request-payer <value>]
[--checksum-mode <value>]
[--checksum-algorithm <value>]
[--metadata <value>]
[--copy-props <value>]
[--metadata-directive <value>]
[--case-conflict <value>]
[--no-overwrite]
[--size-only]
[--exact-timestamps]
[--delete]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]
```

## Options

`paths` (string)

`--dryrun` (boolean)
Displays the operations that would be performed using the specified command without actually running them.

`--quiet` (boolean)
Does not display the operations performed from the specified command.

`--include` (string)
Don’t exclude files or objects in the command that match the specified pattern. See [Use of Exclude and Include Filters](http://docs.aws.amazon.com/cli/latest/reference/s3/index.html#use-of-exclude-and-include-filters) for details.

`--exclude` (string)
Exclude all files or objects from the command that matches the specified pattern.

`--acl` (string)
Sets the ACL for the object when the command is performed. If you use this parameter you must have the “s3:PutObjectAcl” permission included in the list of actions for your IAM policy. Only accepts values of `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, `bucket-owner-full-control` and `log-delivery-write`. See [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) for details

`--follow-symlinks` | `--no-follow-symlinks` (boolean)
Symbolic links are followed when uploading to S3 from the local filesystem. Note that S3 does not support symbolic links, so the contents of the link target are uploaded under the name of the link. When downloading from S3, `--no-follow-symlinks` skips any object whose destination is a symbolic link, or is located under one, starting at the destination you specified. Symbolic links in the path leading up to that destination are still followed. When neither `--follow-symlinks` nor `--no-follow-symlinks` is specified, the default is to follow symlinks.

`--no-guess-mime-type` (boolean)
Do not try to guess the mime type for uploaded files. By default the mime type of a file is guessed when it is uploaded.

`--sse` (string)
Specifies server-side encryption of the object in S3. Valid values are `AES256` and `aws:kms`. If the parameter is specified but no value is provided, `AES256` is used.

`--sse-c` (string)
Specifies server-side encryption using customer provided keys of the the object in S3. `AES256` is the only valid value. If the parameter is specified but no value is provided, `AES256` is used. If you provide this value, `--sse-c-key` must be specified as well.

`--sse-c-key` (blob)
The customer-provided encryption key to use to server-side encrypt the object in S3. If you provide this value, `--sse-c` must be specified as well. The key provided should **not** be base64 encoded.

`--sse-kms-key-id` (string)
The customer-managed AWS Key Management Service (KMS) key ID that should be used to server-side encrypt the object in S3. You should only provide this parameter if you are using a customer managed customer master key (CMK) and not the AWS managed KMS CMK.

`--sse-c-copy-source` (string)
This parameter should only be specified when copying an S3 object that was encrypted server-side with a customer-provided key. It specifies the algorithm to use when decrypting the source object. `AES256` is the only valid value. If the parameter is specified but no value is provided, `AES256` is used. If you provide this value, `--sse-c-copy-source-key` must be specified as well.

`--sse-c-copy-source-key` (blob)
This parameter should only be specified when copying an S3 object that was encrypted server-side with a customer-provided key. Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided must be one that was used when the source object was created. If you provide this value, `--sse-c-copy-source` be specified as well. The key provided should **not** be base64 encoded.

`--storage-class` (string)
The type of storage to use for the object. Valid choices are: STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | GLACIER_IR. Defaults to ‘STANDARD’

`--tags` (string)
Tags to set on objects, in the format of `--tags key value`. You can specify this flag multiple times, once for each tag. This parameter is only supported when transferring from a local path to S3. For a `sync`, tags are only set on objects that are transferred.

`--grants` (string)

> Grant specific permissions to individual users or groups. You can supply a list of grants of the form

> ```
> --grants Permission=Grantee_Type=Grantee_ID [Permission=Grantee_Type=Grantee_ID ...]
> ```

> To specify the same permission type for multiple grantees, specify the permission as such as

> ```
> --grants Permission=Grantee_Type=Grantee_ID,Grantee_Type=Grantee_ID,...
> ```

> Each value contains the following elements:

> * `Permission` - Specifies the granted permissions, and can be set to read, readacl, writeacl, or full.
> * `Grantee_Type` - Specifies how the grantee is to be identified, and can be set to uri or id.
> * `Grantee_ID` - Specifies the grantee based on Grantee_Type. The `Grantee_ID` value can be one of:
>   * **uri** - The group’s URI. For more information, see [Who Is a Grantee?](http://docs.aws.amazon.com/AmazonS3/latest/dev/ACLOverview.html#SpecifyingGrantee)
>   * **id** - The account’s canonical ID

> For more information on Amazon S3 access control, see [Access Control](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAuthAccess.html)

`--website-redirect` (string)
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.

`--content-type` (string)
Specify an explicit content type for this operation. This value overrides any guessed mime types.

`--cache-control` (string)
Specifies caching behavior along the request/reply chain.

`--content-disposition` (string)
Specifies presentational information for the object.

`--content-encoding` (string)
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.

`--content-language` (string)
The language the content is in.

`--expires` (string)
The date and time at which the object is no longer cacheable.

`--source-region` (string)
When transferring objects from an s3 bucket to an s3 bucket, this specifies the region of the source bucket. Note the region specified by `--region` or through configuration of the CLI refers to the region of the destination bucket. If `--source-region` is not specified the region of the source will be the same as the region of the destination bucket.

`--only-show-errors` (boolean)
Only errors and warnings are displayed. All other output is suppressed.

`--no-progress` (boolean)
File transfer progress is not displayed. This flag is only applied when the quiet and only-show-errors flags are not provided.

`--progress-frequency` (integer)
Number of seconds to wait before updating file transfer progress. This flag is only applied when the quiet and only-show-errors flags are not provided.

`--progress-multiline` (boolean)
Show progress on multiple lines.

`--page-size` (integer)
The number of results to return in each response to a list operation. The default value is 1000 (the maximum allowed). Using a lower value may help if an operation times out.

`--ignore-glacier-warnings` (boolean)
Turns off glacier warnings. Warnings about an operation that cannot be performed because it involves copying, downloading, or moving a glacier object will no longer be printed to standard error and will no longer cause the return code of the command to be `2`.

`--force-glacier-transfer` (boolean)
Forces a transfer request on all Glacier objects in a sync or recursive copy.

`--request-payer` (string)
Confirms that the requester knows that they 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.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html](http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html)

`--checksum-mode` (string)
To retrieve the checksum, this mode must be enabled. If the object has a checksum, it will be verified.

`--checksum-algorithm` (string)
Indicates the algorithm used to create the checksum for the object.

`--metadata` (map)
A map of metadata to store with the objects in S3. This will be applied to every object which is part of this request. In a sync, this means that files which haven’t changed won’t receive the new metadata. key -> (string)

> value -> (string)

Shorthand Syntax:

```
KeyName1=string,KeyName2=string
```

JSON Syntax:

```json
{"string": "string"
  ...}
```

`--copy-props` (string)
Determines which properties are copied from the source S3 object. This parameter only applies for S3 to S3 copies. Valid values are:

> * `none` - Do not copy any of the properties from the source S3 object.
> * `metadata-directive` - Copies the following properties from the source S3 object: `content-type`, `content-language`, `content-encoding`, `content-disposition`, `cache-control`, `--expires`, and `metadata`
> * `default` - The default value. Copies tags and properties covered under the `metadata-directive` value from the source S3 object.
> * `all` - Copies annotations in addition to the tags and properties covered under the `default` value from the source S3 object.

> In order to copy the appropriate properties for multipart copies, some of the options may require additional API calls if a multipart copy is involved. Specifically:

> * `metadata-directive` may require additional `HeadObject` API calls.
> * `default` may require additional `HeadObject`, `GetObjectTagging`, and `PutObjectTagging` API calls.
> * `all` may require the additional API calls covered under the `default` value, as well as `ListObjectAnnotations`, `GetObjectAnnotation`, and `PutObjectAnnotation` API calls. Note this list of API calls may grow in the future in order to ensure multipart copies preserve the exact properties a `CopyObject` API call would preserve.

> If you want to guarantee no additional API calls are made other than than the ones needed to perform the actual copy, set this option to `none`.

`--metadata-directive` (string)
Sets the `x-amz-metadata-directive` header for CopyObject operations. It is recommended to use the `--copy-props` parameter instead to control copying of metadata properties. If `--metadata-directive` is set, the `--copy-props` parameter will be disabled and will have no affect on the transfer.

`--case-conflict` (string)
Configures behavior when attempting to download multiple objects whose keys differ only by case, which can cause undefined behavior on case-insensitive filesystems. This parameter only applies for commands that perform multiple S3 to local downloads. See [Handling case conflicts](https://docs.aws.amazon.com/cli/latest/topic/s3-case-insensitivity.html) for details. Valid values are:

> * `error` - Raise an error and abort downloads.
> * `warn` - Emit a warning and download the object.
> * `skip` - Skip downloading the object.
> * `ignore` - The default value. Ignore the conflict and download the object.

`--no-overwrite` (boolean)
This flag prevents overwriting of files at the destination. With this flag, only files not present at the destination will be transferred.

`--size-only` (boolean)
Makes the size of each key the only criteria used to decide whether to sync from source to destination.

`--exact-timestamps` (boolean)
When syncing from S3 to local, same-sized items will be ignored only when the timestamps match exactly. The default behavior is to ignore same-sized items unless the local version is newer than the S3 version.

`--delete` (boolean)
Files that exist in the destination but not in the source are deleted during sync. Note that files excluded by filters are excluded from deletion.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**Example 1: To sync all local objects to the specified bucket**

The following `sync` example syncs objects from a local directory to the specified prefix and bucket by
uploading the local files to S3.  A local file will require uploading if the size of the local file is different than
the size of the S3 object, the last modified time of the local file is newer than the last modified time of the S3
object, or the local file does not exist under the specified bucket and prefix.  In this example, the user syncs the
bucket `amzn-s3-demo-bucket` to the local current directory.  The local current directory contains the files `test.txt` and
`test2.txt`.  The bucket `amzn-s3-demo-bucket` contains no objects.

```bash
aws s3 sync . s3://amzn-s3-demo-bucket
```

Output:

```
upload: test.txt to s3://amzn-s3-demo-bucket/test.txt
upload: test2.txt to s3://amzn-s3-demo-bucket/test2.txt
```

**Example 2: To sync all S3 objects from the specified S3 bucket to another bucket**

The following `sync` example syncs objects under a specified prefix and bucket to objects under another specified
prefix and bucket by copying S3 objects. An S3 object will require copying if the sizes of the two S3 objects differ,
the last modified time of the source is newer than the last modified time of the destination, or the S3 object does not
exist under the specified bucket and prefix destination.

In this example, the user syncs the bucket `amzn-s3-demo-bucket` to the bucket `amzn-s3-demo-bucket2`. The bucket `amzn-s3-demo-bucket` contains the objects `test.txt` and `test2.txt`. The bucket
`amzn-s3-demo-bucket2` contains no objects.

```bash
aws s3 sync s3://amzn-s3-demo-bucket s3://amzn-s3-demo-bucket2
```

Output:

```
copy: s3://amzn-s3-demo-bucket/test.txt to s3://amzn-s3-demo-bucket2/test.txt
copy: s3://amzn-s3-demo-bucket/test2.txt to s3://amzn-s3-demo-bucket2/test2.txt
```

**Example 3: To sync all S3 objects from the specified S3 bucket to the local directory**

The following `sync` example syncs files from the specified S3 bucket to the local directory by
downloading S3 objects. An S3 object will require downloading if the size of the S3 object differs from the size of the
local file, the last modified time of the S3 object is newer than the last modified time of the local file, or the S3
object does not exist in the local directory. Take note that when objects are downloaded from S3, the last modified
time of the local file is changed to the last modified time of the S3 object. In this example, the user syncs the
bucket `amzn-s3-demo-bucket` to the current local directory. The bucket `amzn-s3-demo-bucket` contains the objects `test.txt` and
`test2.txt`.  The current local directory has no files.

```bash
aws s3 sync s3://amzn-s3-demo-bucket .
```

Output:

```
download: s3://amzn-s3-demo-bucket/test.txt to test.txt
download: s3://amzn-s3-demo-bucket/test2.txt to test2.txt
```

**Example 4: To sync all local objects to the specified bucket and delete all files that do not match**

The following `sync` example syncs objects under a specified prefix and bucket to files in a local directory by
uploading the local files to S3.  Because of the `--delete` parameter, any files existing under the
specified prefix and bucket but not existing in the local directory will be deleted.  In this example, the user syncs
the bucket `amzn-s3-demo-bucket` to the local current directory.  The local current directory contains the files `test.txt` and
`test2.txt`.  The bucket `amzn-s3-demo-bucket` contains the object `test3.txt`.

```bash
aws s3 sync . s3://amzn-s3-demo-bucket \
    --delete
```

Output:

```
upload: test.txt to s3://amzn-s3-demo-bucket/test.txt
upload: test2.txt to s3://amzn-s3-demo-bucket/test2.txt
delete: s3://amzn-s3-demo-bucket/test3.txt
```

**Example 5: To sync all local objects to the specified bucket except \`\`.jpg\`\` files**

The following `sync` example syncs objects under a specified prefix and bucket to files in a local directory by
uploading the local files to S3. Because of the `--exclude` parameter, all files matching the pattern
existing both in S3 and locally will be excluded from the sync. In this example, the user syncs the bucket `amzn-s3-demo-bucket`
to the local current directory.  The local current directory contains the files `test.jpg` and `test2.txt`.  The
bucket `amzn-s3-demo-bucket` contains the object `test.jpg` of a different size than the local `test.jpg`.

```bash
aws s3 sync . s3://amzn-s3-demo-bucket \
    --exclude "*.jpg"
```

Output:

```
upload: test2.txt to s3://amzn-s3-demo-bucket/test2.txt
```

**Example 6: To sync all local objects to the specified bucket except specified directory files**

The following `sync` example syncs files under a local directory to objects under a specified prefix and bucket by
downloading S3 objects.  This example uses the `--exclude` parameter flag to exclude a specified directory
and S3 prefix from the `sync` command.  In this example, the user syncs the local current directory to the bucket
`amzn-s3-demo-bucket`.  The local current directory contains the files `test.txt` and `another/test2.txt`.  The bucket
`amzn-s3-demo-bucket` contains the objects `another/test5.txt` and `test1.txt`.

```bash
aws s3 sync s3://amzn-s3-demo-bucket/ . \
    --exclude "*another/*"
```

Output:

```
download: s3://amzn-s3-demo-bucket/test1.txt to test1.txt
```

**Example 7: To sync all objects between buckets in different regions**

The following `sync` example syncs files between two buckets in different regions.

```bash
aws s3 sync s3://amzn-s3-demo-bucket1 s3://amzn-s3-demo-bucket2 \
    --source-region us-west-2 \
    --region us-east-1
```

Output:

```
download: s3://amzn-s3-demo-bucket1/test1.txt to s3://amzn-s3-demo-bucket2/test1.txt
```

**Example 8: To sync to an S3 access point**

The following `sync` example syncs the current directory to the access point (`myaccesspoint`).

```bash
aws s3 sync . s3://arn:aws:s3:us-west-2:123456789012:accesspoint/myaccesspoint/
```

Output:

```
upload: test.txt to s3://arn:aws:s3:us-west-2:123456789012:accesspoint/myaccesspoint/test.txt
upload: test2.txt to s3://arn:aws:s3:us-west-2:123456789012:accesspoint/myaccesspoint/test2.txt
```

**Example 9: To sync a local directory to a bucket with tags**

The following `sync` example syncs the current directory to a specified bucket while setting two tags on each uploaded object. Specify `--tags` once per tag, separating the key and value with a space. Tags are set only on objects that are actually uploaded.

```bash
aws s3 sync . s3://amzn-s3-demo-bucket \
    --tags key1 value1 \
    --tags key2 value2
```

Output:

```
upload: test.txt to s3://amzn-s3-demo-bucket/test.txt
upload: test2.txt to s3://amzn-s3-demo-bucket/test2.txt
```

For more information, see [Using high-level (s3) commands in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-services-s3-commands.html#using-s3-commands-managing-objects-sync) in the *AWS CLI User Guide*.