MigrationHub / Client / describe_migration_task

describe_migration_task#

MigrationHub.Client.describe_migration_task(**kwargs)#

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

Request Syntax

response = client.describe_migration_task(
    ProgressUpdateStream='string',
    MigrationTaskName='string'
)

Parameters:

ProgressUpdateStream (string) –
[REQUIRED]

The name of the ProgressUpdateStream.
MigrationTaskName (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'MigrationTask': {
        'ProgressUpdateStream': 'string',
        'MigrationTaskName': 'string',
        'Task': {
            'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
            'StatusDetail': 'string',
            'ProgressPercent': 123
        },
        'UpdateDateTime': datetime(2015, 1, 1),
        'ResourceAttributeList': [
            {
                'Type': 'IPV4_ADDRESS'|'IPV6_ADDRESS'|'MAC_ADDRESS'|'FQDN'|'VM_MANAGER_ID'|'VM_MANAGED_OBJECT_REFERENCE'|'VM_NAME'|'VM_PATH'|'BIOS_ID'|'MOTHERBOARD_SERIAL_NUMBER',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- MigrationTask (dict) –
  
  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 (dict) –
    
    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 (datetime) –
    
    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.
    - (dict) –
      
      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.

Exceptions

MigrationHub.Client.exceptions.AccessDeniedException
MigrationHub.Client.exceptions.ThrottlingException
MigrationHub.Client.exceptions.InternalServerError
MigrationHub.Client.exceptions.ServiceUnavailableException
MigrationHub.Client.exceptions.InvalidInputException
MigrationHub.Client.exceptions.ResourceNotFoundException
MigrationHub.Client.exceptions.HomeRegionNotSetException