S3Tables / Client / list_table_migrations

list_table_migrations

S3Tables.Client.list_table_migrations(**kwargs)

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

Request Syntax

response = client.list_table_migrations(
    tableBucketARN='string',
    namespace='string',
    name='string',
    tableARN='string',
    state='new'|'planning'|'pendingReview'|'queued'|'migrating'|'succeeded'|'failed'|'cancelling'|'cancelled',
    hasValidPlan=True|False,
    maxResults=123,
    nextToken='string'
)
Parameters:

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

  • namespace (string) – The namespace to list migrations for. Requires tableBucketARN.

  • name (string) – The name of the table to list migrations for. Requires tableBucketARN and namespace.

  • tableARN (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.

  • state (string) – The state to filter the list by. For the valid values, see the state member of GetTableMigration.

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

  • maxResults (integer) – The maximum number of migrations to return, from 1 to 1,000. If you don’t specify a value, the default is 100.

  • nextToken (string) – The nextToken from a previous response, to get the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'migrations': [
        {
            'migrationId': 'string',
            'tableBucketARN': 'string',
            'namespace': 'string',
            'tableARN': 'string',
            'name': 'string',
            'type': 'start'|'sync',
            'state': 'new'|'planning'|'pendingReview'|'queued'|'migrating'|'succeeded'|'failed'|'cancelling'|'cancelled',
            'hasValidPlan': True|False,
            'createdAt': datetime(2015, 1, 1),
            'stateUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • migrations (list) –

      The migrations, newest first.

      • (dict) –

        A summary of a migration.

        • migrationId (string) –

          The ID of the migration.

        • tableBucketARN (string) –

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

        • namespace (string) –

          The namespace of the destination table.

        • tableARN (string) –

          The Amazon Resource Name (ARN) of the destination table, once the migration creates it.

        • name (string) –

          The name of the destination table.

        • type (string) –

          The type of the migration. Valid values:

          • start - A migration that StartTableMigration started.

          • sync - A migration that SyncTableMigration started.

        • state (string) –

          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.

        • 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 (datetime) –

          The date and time that the migration was created.

        • stateUpdatedAt (datetime) –

          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.

Exceptions