Method: Aws::MigrationHub::Client#describe_migration_task

Defined in:

lib/aws-sdk-migrationhub/client.rb

#describe_migration_task(params = {}) ⇒ Types::DescribeMigrationTaskResult

Retrieves a list of all attributes associated with a specific migration task.

Examples:

Request syntax with placeholder values

resp = client.describe_migration_task({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
})

Response structure

resp.migration_task.progress_update_stream #=> String
resp.migration_task.migration_task_name #=> String
resp.migration_task.task.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.migration_task.task.status_detail #=> String
resp.migration_task.task.progress_percent #=> Integer
resp.migration_task.update_date_time #=> Time
resp.migration_task.resource_attribute_list #=> Array
resp.migration_task.resource_attribute_list[0].type #=> String, one of "IPV4_ADDRESS", "IPV6_ADDRESS", "MAC_ADDRESS", "FQDN", "VM_MANAGER_ID", "VM_MANAGED_OBJECT_REFERENCE", "VM_NAME", "VM_PATH", "BIOS_ID", "MOTHERBOARD_SERIAL_NUMBER"
resp.migration_task.resource_attribute_list[0].value #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :progress_update_stream (required, String) —

  The name of the ProgressUpdateStream.

• :migration_task_name (required, String) —

  The identifier given to the MigrationTask. *Do not store personal data in this field.*

Returns:

• (Types::DescribeMigrationTaskResult) —

  Returns a response object which responds to the following methods:

  • #migration_task => Types::MigrationTask

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-migrationhub/client.rb', line 780

def describe_migration_task(params = {}, options = {})
  req = build_request(:describe_migration_task, params)
  req.send_request(options)
end