S3Tables / Client / update_table_migration

update_table_migration

S3Tables.Client.update_table_migration(**kwargs)

Requests a state change for a migration. Identify the migration by its migrationId or by the tableARN of its destination table.

Set requestedState to queued to continue a migration in the pendingReview state; the migration moves to queued or migrating. Set it to cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state; the migration moves to cancelling, finishes the work in progress, and then ends in the cancelled state, or in the failed state if any objects failed to migrate. Data that the migration already committed stays in the destination table.

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.update_table_migration(
    tableARN='string',
    migrationId='string',
    requestedState='queued'|'cancelled',
    updateDescription='string'
)
Parameters:

  • tableARN (string) – The Amazon Resource Name (ARN) of the destination table. Updates the table’s most recent migration. Until the migration creates the destination table, specify migrationId. Specify either tableARN or migrationId, not both.

  • migrationId (string) – The ID of the migration to update. Specify either migrationId or tableARN, not both.

  • requestedState (string) –

    [REQUIRED]

    The state to move the migration to: queued to continue a migration in the pendingReview state, or cancelled to cancel a migration in the new, planning, pendingReview, queued or migrating state.

  • updateDescription (string) – A description of the update, up to 1,024 characters, with no control characters. GetTableMigration doesn’t return it.

Return type:

dict

Returns:

Response Syntax

{
    'migrationId': 'string',
    'state': 'new'|'planning'|'pendingReview'|'queued'|'migrating'|'succeeded'|'failed'|'cancelling'|'cancelled',
    'tableARN': 'string'
}

Response Structure

  • (dict) –

    • migrationId (string) –

      The ID of the migration.

    • state (string) –

      The state of the migration after the update, such as queued, migrating or cancelling.

    • tableARN (string) –

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

Exceptions