MigrationHubOrchestrator / Client / get_template_step

get_template_step#

MigrationHubOrchestrator.Client.get_template_step(**kwargs)#

Get a specific step in a template.

See also: AWS API Documentation

Request Syntax

response = client.get_template_step(
    id='string',
    templateId='string',
    stepGroupId='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The ID of the step.

  • templateId (string) –

    [REQUIRED]

    The ID of the template.

  • stepGroupId (string) –

    [REQUIRED]

    The ID of the step group.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'stepGroupId': 'string',
    'templateId': 'string',
    'name': 'string',
    'description': 'string',
    'stepActionType': 'MANUAL'|'AUTOMATED',
    'creationTime': 'string',
    'previous': [
        'string',
    ],
    'next': [
        'string',
    ],
    'outputs': [
        {
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'STRINGLIST'|'STRINGMAP',
            'required': True|False
        },
    ],
    'stepAutomationConfiguration': {
        'scriptLocationS3Bucket': 'string',
        'scriptLocationS3Key': {
            'linux': 'string',
            'windows': 'string'
        },
        'command': {
            'linux': 'string',
            'windows': 'string'
        },
        'runEnvironment': 'AWS'|'ONPREMISE',
        'targetType': 'SINGLE'|'ALL'|'NONE'
    }
}

Response Structure

  • (dict) –

    • id (string) –

      The ID of the step.

    • stepGroupId (string) –

      The ID of the step group.

    • templateId (string) –

      The ID of the template.

    • name (string) –

      The name of the step.

    • description (string) –

      The description of the step.

    • stepActionType (string) –

      The action type of the step. You must run and update the status of a manual step for the workflow to continue after the completion of the step.

    • creationTime (string) –

      The time at which the step was created.

    • previous (list) –

      The previous step.

      • (string) –

    • next (list) –

      The next step.

      • (string) –

    • outputs (list) –

      The outputs of the step.

      • (dict) –

        The output of the step.

        • name (string) –

          The name of the step.

        • dataType (string) –

          The data type of the step output.

        • required (boolean) –

          Determine if an output is required from a step.

    • stepAutomationConfiguration (dict) –

      The custom script to run tests on source or target environments.

      • scriptLocationS3Bucket (string) –

        The Amazon S3 bucket where the script is located.

      • scriptLocationS3Key (dict) –

        The Amazon S3 key for the script location.

        • linux (string) –

          The script location for Linux.

        • windows (string) –

          The script location for Windows.

      • command (dict) –

        The command to run the script.

        • linux (string) –

          Command for Linux.

        • windows (string) –

          Command for Windows.

      • runEnvironment (string) –

        The source or target environment.

      • targetType (string) –

        The servers on which to run the script.

Exceptions