You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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)


768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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

#migration_task_nameString

Unique identifier that references the migration task.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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

#next_update_secondsInteger

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)


768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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

#progress_update_streamString

The name of the ProgressUpdateStream.

Returns:

  • (String)


768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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

#taskTypes::Task

Information about the task's progress and status.

Returns:



768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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

#update_date_timeTime

The timestamp when the task was gathered.

Returns:

  • (Time)


768
769
770
771
772
773
774
775
776
# File 'gems/aws-sdk-migrationhub/lib/aws-sdk-migrationhub/types.rb', line 768

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