MigrationHubOrchestrator / Paginator / ListTemplates

ListTemplates

class MigrationHubOrchestrator.Paginator.ListTemplates

paginator = client.get_paginator('list_templates')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• name (string) – The name 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

{
    'templateSummary': [
        {
            'id': 'string',
            'name': 'string',
            'arn': 'string',
            'description': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • templateSummary (list) –

    The summary of the template.

    • (dict) –

      The summary of the template.

      • id (string) –

        The ID of the template.

      • name (string) –

        The name of the template.

      • arn (string) –

        The Amazon Resource Name (ARN) of the template.

      • description (string) –

        The description of the template.

  • NextToken (string) –

    A token to resume pagination.