Class: Aws::MigrationHub::Types::NotifyMigrationTaskStateRequest

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

Overview

Note:

When making an API call, you may pass NotifyMigrationTaskStateRequest data as a hash:

{
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  task: { # required
    status: "NOT_STARTED", # required, accepts NOT_STARTED, IN_PROGRESS, FAILED, COMPLETED
    status_detail: "StatusDetail",
    progress_percent: 1,
  },
  update_date_time: Time.now, # required
  next_update_seconds: 1, # required
  dry_run: false,
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

Returns:

  • (Boolean) 


966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#migration_task_name ⇒ String

Unique identifier that references the migration task. Do not store personal data in this field.

Returns:

  • (String) 


966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#next_update_seconds ⇒ Integer

Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

Returns:

  • (Integer) 


966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#progress_update_stream ⇒ String

The name of the ProgressUpdateStream.

Returns:

  • (String) 


966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#task ⇒ Types::Task

Information about the task's progress and status.

Returns:



966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#update_date_time ⇒ Time

The timestamp when the task was gathered.

Returns:

  • (Time) 


966
967
968
969
970
971
972
973
974
975
 
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 966

class NotifyMigrationTaskStateRequest < Struct.new(
  :progress_update_stream,
  :migration_task_name,
  :task,
  :update_date_time,
  :next_update_seconds,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end