Class: Aws::S3Tables::Types::GetTableMigrationResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The date and time that the migration was created.

Returns:

  • (Time) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#data_migration ⇒ Types::DataMigrationOverview

The maintenance settings and migration policies for the destination table.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ Types::MigrationFailureReason

The reason that the migration failed. The code names the cause, such as a migration role that S3 Tables can't assume or an Amazon Web Services Glue table that doesn't exist, or the report that lists the findings. This value is returned only when the migration is in the failed state.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#has_valid_plan ⇒ 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.

Returns:

  • (Boolean) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#migration_id ⇒ String

The ID of the migration.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#migration_output ⇒ Types::MigrationOutputOverview

The bucket and prefixes for the migration's reports, and the location of each report once it is written.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#migration_stats ⇒ Types::MigrationStats

The number of objects that migrated, failed or are pending. These counts are set when planning finishes and updated when the migration ends.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the destination table.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the destination table.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#planning_stats ⇒ Types::PlanningStats

Statistics about the source and the partitions in the migration. This value is returned after planning finishes.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#review_migration_plan ⇒ Boolean

A Boolean value that specifies whether the migration waits in the pendingReview state, so that you can review the compatibility reports before it migrates any data.

Returns:

  • (Boolean) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the migration uses.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::SourceConfiguration

The source table of the migration.

Returns:



1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#source_type ⇒ String

The type of the migration's source.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

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

A migration ends in the succeeded, failed or cancelled state. You can cancel it until it ends.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#state_updated_at ⇒ Time

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

Returns:

  • (Time) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#table_arn ⇒ String

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

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#table_bucket_arn ⇒ String

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

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the migration. Valid values:

  • start - A migration that StartTableMigration started.

  • sync - A migration that SyncTableMigration started.

Returns:

  • (String) 


1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
 
# File 'gems/aws-sdk-s3tables/lib/aws-sdk-s3tables/types.rb', line 1178

class GetTableMigrationResponse < Struct.new(
  :migration_id,
  :table_bucket_arn,
  :namespace,
  :table_arn,
  :name,
  :type,
  :state,
  :role_arn,
  :review_migration_plan,
  :has_valid_plan,
  :created_at,
  :state_updated_at,
  :failure_reason,
  :planning_stats,
  :migration_stats,
  :source_type,
  :source,
  :data_migration,
  :migration_output)
  SENSITIVE = []
  include Aws::Structure
end