Method: Aws::MigrationHub::Client#list_migration_task_updates

Defined in:

lib/aws-sdk-migrationhub/client.rb

#list_migration_task_updates(params = {}) ⇒ Types::ListMigrationTaskUpdatesResult

This is a paginated API that returns all the migration-task states for the specified ‘MigrationTaskName` and `ProgressUpdateStream`.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.list_migration_task_updates({
  progress_update_stream: "ProgressUpdateStream", # required
  migration_task_name: "MigrationTaskName", # required
  next_token: "Token",
  max_results: 1,
})

Response structure

resp.next_token #=> String
resp.migration_task_update_list #=> Array
resp.migration_task_update_list[0].update_date_time #=> Time
resp.migration_task_update_list[0].update_type #=> String, one of "MIGRATION_TASK_STATE_UPDATED"
resp.migration_task_update_list[0].migration_task_state.status #=> String, one of "NOT_STARTED", "IN_PROGRESS", "FAILED", "COMPLETED"
resp.migration_task_update_list[0].migration_task_state.status_detail #=> String
resp.migration_task_update_list[0].migration_task_state.progress_percent #=> Integer

Parameters:

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

  ({})

Options Hash (params):

• :progress_update_stream (required, String) —

  The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

• :migration_task_name (required, String) —

  A unique identifier that references the migration task. *Do not include sensitive data in this field.*

• :next_token (String) —

  If ‘NextToken` was returned by a previous call, there are more results available. The value of `NextToken` is a unique pagination token for each page. To retrieve the next page of results, specify the `NextToken` value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

• :max_results (Integer) —

  The maximum number of results to include in the response. If more results exist than the value that you specify here for ‘MaxResults`, the response will include a token that you can use to retrieve the next set of results.

Returns:

• (Types::ListMigrationTaskUpdatesResult) —

  Returns a response object which responds to the following methods:

  • #next_token => String

  • #migration_task_update_list => Array<Types::MigrationTaskUpdate>

See Also:

• AWS API Documentation

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

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