[ aws . mgh ]

describe-migration-task

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-migration-task
--progress-update-stream <value>
--migration-task-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--progress-update-stream (string)

The name of the ProgressUpdateStream.

--migration-task-name (string)

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

MigrationTask -> (structure)

Object encapsulating information about the migration task.

ProgressUpdateStream -> (string)

A name that identifies the vendor of the migration tool being used.

MigrationTaskName -> (string)

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

Task -> (structure)

Task object encapsulating task information.

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.

UpdateDateTime -> (timestamp)

The timestamp when the task was gathered.

ResourceAttributeList -> (list)

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service repository.

(structure)

Attribute associated with a resource.

Note the corresponding format required per type listed below:

IPV4

x.x.x.x

where x is an integer in the range [0,255]

IPV6

y : y : y : y : y : y : y : y

where y is a hexadecimal between 0 and FFFF. [0, FFFF]

MAC_ADDRESS

^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

FQDN

^[^<>{}\\\\/?,=\\p{Cntrl}]{1,256}$

Type -> (string)

Type of resource.

Value -> (string)

Value of the resource type.