ListTemplateSteps

class MigrationHubOrchestrator.Paginator.ListTemplateSteps

paginator = client.get_paginator('list_template_steps')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubOrchestrator.Client.list_template_steps().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    templateId='string',
    stepGroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• templateId (string) --

  [REQUIRED]

  The ID of the template.

• stepGroupId (string) --

  [REQUIRED]

  The ID of the step group.

• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'templateStepSummaryList': [
        {
            'id': 'string',
            'stepGroupId': 'string',
            'templateId': 'string',
            'name': 'string',
            'stepActionType': 'MANUAL'|'AUTOMATED',
            'targetType': 'SINGLE'|'ALL'|'NONE',
            'owner': 'AWS_MANAGED'|'CUSTOM',
            'previous': [
                'string',
            ],
            'next': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • templateStepSummaryList (list) --

    The list of summaries of steps in a template.

    • (dict) --

      The summary of the step.

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

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

      • targetType (string) --

        The servers on which to run the script.

      • owner (string) --

        The owner of the step.

      • previous (list) --

        The previous step.

        • (string) --

      • next (list) --

        The next step.

        • (string) --

  • NextToken (string) --

    A token to resume pagination.