MigrationHubOrchestrator / Paginator / ListTemplateStepGroups

ListTemplateStepGroups#

class MigrationHubOrchestrator.Paginator.ListTemplateStepGroups#
paginator = client.get_paginator('list_template_step_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The ID of the template.

  • 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

{
    'templateStepGroupSummary': [
        {
            'id': 'string',
            'name': 'string',
            'previous': [
                'string',
            ],
            'next': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • templateStepGroupSummary (list) –

      The summary of the step group in the template.

      • (dict) –

        The summary of the step group in the template.

        • id (string) –

          The ID of the step group.

        • name (string) –

          The name of the step group.

        • previous (list) –

          The previous step group.

          • (string) –

        • next (list) –

          The next step group.

          • (string) –

    • NextToken (string) –

      A token to resume pagination.