Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . mgh ]

notify-migration-task-state

Description

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

  • Migration tools will call the notify-migration-task-state API to share the latest progress and status.
  • migration-task-name is used for addressing updates to the correct target.
  • progress-update-stream is used for access control and to provide a namespace for each migration tool.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  notify-migration-task-state
--progress-update-stream <value>
--migration-task-name <value>
--task <value>
--update-date-time <value>
--next-update-seconds <value>
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--progress-update-stream (string)

The name of the ProgressUpdateStream.

--migration-task-name (string)

Unique identifier that references the migration task.

--task (structure)

Information about the task's progress and status.

Shorthand Syntax:

Status=string,StatusDetail=string,ProgressPercent=integer

JSON Syntax:

{
  "Status": "NOT_STARTED"|"IN_PROGRESS"|"FAILED"|"COMPLETED",
  "StatusDetail": "string",
  "ProgressPercent": integer
}

--update-date-time (timestamp)

The timestamp when the task was gathered.

--next-update-seconds (integer)

Number of seconds after the update-date-time 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.

--dry-run | --no-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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output