[ 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 NotifyMigrationTaskState API to share the latest progress and status.

• MigrationTaskName is used for addressing updates to the correct target.

• ProgressUpdateStream 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--progress-update-stream (string)

The name of the ProgressUpdateStream.

--migration-task-name (string)

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

--task (structure)

Information about the task’s progress and status.

Status -> (string)

Status of the task - Not Started, In-Progress, Complete.

StatusDetail -> (string)

Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

ProgressPercent -> (integer)

Indication of the percentage completion of the task.

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 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.

--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

None