get_template

MigrationHubOrchestrator.Client.get_template(**kwargs)

Get the template you want to use for creating a migration workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_template(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the template.

Return type

dict

Returns

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'description': 'string',
    'inputs': [
        {
            'inputName': 'string',
            'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP',
            'required': True|False
        },
    ],
    'tools': [
        {
            'name': 'string',
            'url': 'string'
        },
    ],
    'status': 'CREATED',
    'creationTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) --
  • id (string) --

    The ID of the template.

  • name (string) --

    The name of the template.

  • description (string) --

    The time at which the template was last created.

  • inputs (list) --

    The inputs provided for the creation of the migration workflow.

    • (dict) --

      The input parameters of a template.

      • inputName (string) --

        The name of the template.

      • dataType (string) --

        The data type of the template input.

      • required (boolean) --

        Determine if an input is required from the template.

  • tools (list) --

    List of AWS services utilized in a migration workflow.

    • (dict) --

      List of AWS services utilized in a migration workflow.

      • name (string) --

        The name of an AWS service.

      • url (string) --

        The URL of an AWS service.

  • status (string) --

    The status of the template.

  • creationTime (datetime) --

    The time at which the template was last created.

Exceptions

• MigrationHubOrchestrator.Client.exceptions.ThrottlingException
• MigrationHubOrchestrator.Client.exceptions.AccessDeniedException
• MigrationHubOrchestrator.Client.exceptions.InternalServerException
• MigrationHubOrchestrator.Client.exceptions.ResourceNotFoundException