[ aws . s3tables ]

list-table-migrations

Description

Lists the migrations whose destination is in a table bucket, a namespace or a table. Specify a tableBucketARN to list the migrations into a table bucket, and add a namespace , or a namespace and a name , to narrow the list. Or specify a tableARN to list the migrations into a table.

Migrations are listed newest first. Results are paginated: use maxResults to set the page size, and pass the nextToken from a response to retrieve the next page of results. A page can contain fewer migrations than maxResults , or none, and still return a nextToken . Continue until a response has no nextToken .

Permissions

• You must have the s3tables:ListTableMigrations permission to use this operation.

See also: AWS API Documentation

list-table-migrations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: migrations

Synopsis

  list-table-migrations
[--table-bucket-arn <value>]
[--namespace <value>]
[--name <value>]
[--table-arn <value>]
[--state <value>]
[--has-valid-plan | --no-has-valid-plan]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--table-bucket-arn (string)

The Amazon Resource Name (ARN) of the table bucket to list migrations for.

Constraints:

• pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})

--namespace (string)

The namespace to list migrations for. Requires tableBucketARN .

Constraints:

• min: 1
• max: 255
• pattern: [0-9a-z_]*

--name (string)

The name of the table to list migrations for. Requires tableBucketARN and namespace .

Constraints:

• min: 1
• max: 255
• pattern: [0-9a-z_]*

--table-arn (string)

The Amazon Resource Name (ARN) of the table to list migrations for. The list includes the migrations into this table. To also list migrations into an earlier table of the same name, specify tableBucketARN , namespace and name instead. Specify either tableARN or tableBucketARN , not both.

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})

--state (string)

The state to filter the list by. For the valid values, see the state member of GetTableMigration .

Possible values:

• new
• planning
• pendingReview
• queued
• migrating
• succeeded
• failed
• cancelling
• cancelled

--has-valid-plan | --no-has-valid-plan (boolean)

The hasValidPlan value to filter the list by. Migrations that are still planning aren’t listed, whichever value you specify.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

• min: 1
• max: 1000

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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

migrations -> (list)

The migrations, newest first.

(structure)

A summary of a migration.

migrationId -> (string) [required]

The ID of the migration.

Constraints:

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

tableBucketARN -> (string) [required]

The Amazon Resource Name (ARN) of the table bucket that contains the destination table.

Constraints:

• pattern: (arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})

namespace -> (string) [required]

The namespace of the destination table.

Constraints:

• min: 1
• max: 255
• pattern: [0-9a-z_]*

tableARN -> (string)

The Amazon Resource Name (ARN) of the destination table, once the migration creates 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})

name -> (string) [required]

The name of the destination table.

Constraints:

• min: 1
• max: 255
• pattern: [0-9a-z_]*

type -> (string) [required]

The type of the migration. Valid values:

• start - A migration that StartTableMigration started.
• sync - A migration that SyncTableMigration started.

Possible values:

• start
• sync

state -> (string) [required]

The state of the migration. Valid values:

• new - S3 Tables accepted the request.
• planning - The migration is checking the source table, its objects and the destination for compatibility, and writing the compatibility reports.
• pendingReview - Planning finished, and the migration waits for you to continue or cancel it with UpdateTableMigration .
• queued - The migration is waiting to start migrating data.
• migrating - The migration is running the plan from the planning state: it copies data and commits it to the destination table. A migration reaches this state only if hasValidPlan is true .
• succeeded - Every planned object migrated.
• failed - The migration failed. Check failureReason for the cause.
• cancelling - You cancelled the migration, and it is finishing the work in progress.
• cancelled - The migration is cancelled.

Possible values:

• new
• planning
• pendingReview
• queued
• migrating
• succeeded
• failed
• cancelling
• cancelled

hasValidPlan -> (boolean)

A Boolean value that specifies whether planning produced a plan that the migration can run. If planning hasn’t finished, this value isn’t returned.

createdAt -> (timestamp) [required]

The date and time that the migration was created.

stateUpdatedAt -> (timestamp) [required]

The date and time that the migration’s state last changed.

nextToken -> (string)

A token to pass as nextToken to get the next page of results. If there are no more results, this value isn’t returned.

Constraints:

• min: 1
• max: 2048