AWS CLI Command Reference

[ aws . s3tables ]

sync-table-migration

Description

Migrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table. The sync runs asynchronously: this operation returns the migration ID of the sync and its initial state, and you track progress with GetTableMigration .

A sync uses the source, destination and data migration settings of the table’s migration, and plans the work and writes its reports in the same way as StartTableMigration . You can sync after a start or sync that succeeded, failed or was cancelled, if an earlier start or sync of the table has a valid plan (hasValidPlan ). You can’t sync a table while a start or sync is in progress for it, and you can sync a table until you call CompleteTableMigration for it. If a source object that an earlier migration migrated has since been overwritten, the sync fails.

Permissions
  • You must have the s3tables:SyncTableMigration permission to use this operation.
  • You must have the iam:PassRole permission on the role that you specify in roleARN , with a condition that allows passing it to migration.s3tables.amazonaws.com . The associated resource is the table.

See also: AWS API Documentation

Synopsis

  sync-table-migration
--role-arn <value>
--table-arn <value>
[--review-migration-plan | --no-review-migration-plan]
--migration-output <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--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

--role-arn (string) [required]

The Amazon Resource Name (ARN) of the IAM role that the sync uses to read the source table and its data and to write the destination table and the reports. The role must be in your account, and its trust policy must allow migration.s3tables.amazonaws.com to assume it. You can limit the trust policy to the destination table bucket with the aws:SourceArn and aws:SourceAccount condition keys.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/.+

--table-arn (string) [required]

The Amazon Resource Name (ARN) of the destination table to sync. The table must have a migration, and you must not have called CompleteTableMigration for it.

Constraints:

  • min: 1
  • max: 2048
  • pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63}/table/[a-zA-Z0-9-_]{1,255})

--review-migration-plan | --no-review-migration-plan (boolean)

Specifies whether the sync waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data. If true , the migration continues when you call UpdateTableMigration with requestedState set to queued . If you don’t continue or cancel the migration within 30 days, the migration fails. The default is false .

--migration-output (structure) [required]

The bucket and prefixes that the sync writes its reports to. The bucket must be a general purpose bucket in your account and in the same Region as the table bucket, and the migration role must be able to write objects to it. Otherwise, the migration fails when it writes its first report.

bucket -> (string) [required]

The general purpose bucket that the migration writes every report to.

Constraints:

  • min: 12
  • max: 1024
  • pattern: arn:aws[-a-z0-9]*:s3[a-z]*:[-a-z0-9]*:([0-9]{12})?:.+

prefixes -> (structure)

The key prefix for each report.

tableCompatibilityReport -> (string)

The key prefix for the table compatibility report, up to 512 bytes. If not specified, the report’s keys start at the root of the bucket.

Constraints:

  • min: 0
  • max: 512

objectCompatibilityReport -> (string)

The key prefix for the object compatibility report, up to 512 bytes. If not specified, the report’s keys start at the root of the bucket.

Constraints:

  • min: 0
  • max: 512

objectMigrationReport -> (string)

The key prefix for the object migration report, up to 512 bytes. If not specified, the report’s keys start at the root of the bucket.

Constraints:

  • min: 0
  • max: 512

Shorthand Syntax:

bucket=string,prefixes={tableCompatibilityReport=string,objectCompatibilityReport=string,objectMigrationReport=string}

JSON Syntax:

{
  "bucket": "string",
  "prefixes": {
    "tableCompatibilityReport": "string",
    "objectCompatibilityReport": "string",
    "objectMigrationReport": "string"
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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.

Output

migrationId -> (string)

The migration ID of the sync.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9-]+

state -> (string)

The state of the migration when the request is accepted, such as planning .

Possible values:

  • new
  • planning
  • pendingReview
  • queued
  • migrating
  • succeeded
  • failed
  • cancelling
  • cancelled
© Copyright 2026, Amazon Web Services. Created using Sphinx.