Backup / Paginator / ListBackupPlanTemplates


class Backup.Paginator.ListBackupPlanTemplates#
paginator = client.get_paginator('list_backup_plan_templates')

Creates an iterator that will paginate through responses from Backup.Client.list_backup_plan_templates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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:



Response Syntax

    'BackupPlanTemplatesList': [
            'BackupPlanTemplateId': 'string',
            'BackupPlanTemplateName': 'string'

Response Structure

  • (dict) –

    • BackupPlanTemplatesList (list) –

      An array of template list items containing metadata about your saved templates.

      • (dict) –

        An object specifying metadata associated with a backup plan template.

        • BackupPlanTemplateId (string) –

          Uniquely identifies a stored backup plan template.

        • BackupPlanTemplateName (string) –

          The optional display name of a backup plan template.