MigrationSummary - Amazon S3
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

MigrationSummary

A summary of a migration.

Contents

createdAt

The date and time that the migration was created.

Type: Timestamp

Required: Yes

migrationId

The ID of the migration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z0-9-]+

Required: Yes

name

The name of the destination table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [0-9a-z_]*

Required: Yes

namespace

The namespace of the destination table.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [0-9a-z_]*

Required: Yes

state

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.

Type: String

Valid Values: new | planning | pendingReview | queued | migrating | succeeded | failed | cancelling | cancelled

Required: Yes

stateUpdatedAt

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

Type: Timestamp

Required: Yes

tableBucketARN

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

Type: String

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

Required: Yes

type

The type of the migration. Valid values:

  • start - A migration that StartTableMigration started.

  • sync - A migration that SyncTableMigration started.

Type: String

Valid Values: start | sync

Required: Yes

hasValidPlan

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.

Type: Boolean

Required: No

tableARN

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 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})

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: