Backup / Paginator / ListBackupPlanVersions

ListBackupPlanVersions

class Backup.Paginator.ListBackupPlanVersions

paginator = client.get_paginator('list_backup_plan_versions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• BackupPlanId (string) –

  [REQUIRED]

  Uniquely identifies a backup plan.

• 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

{
    'BackupPlanVersionsList': [
        {
            'BackupPlanArn': 'string',
            'BackupPlanId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'DeletionDate': datetime(2015, 1, 1),
            'VersionId': 'string',
            'BackupPlanName': 'string',
            'CreatorRequestId': 'string',
            'LastExecutionDate': datetime(2015, 1, 1),
            'AdvancedBackupSettings': [
                {
                    'ResourceType': 'string',
                    'BackupOptions': {
                        'string': 'string'
                    }
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • BackupPlanVersionsList (list) –

    An array of version list items containing metadata about your backup plans.

    • (dict) –

      Contains metadata about a backup plan.

      • BackupPlanArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • BackupPlanId (string) –

        Uniquely identifies a backup plan.

      • CreationDate (datetime) –

        The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • DeletionDate (datetime) –

        The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • VersionId (string) –

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

      • BackupPlanName (string) –

        The display name of a saved backup plan.

      • CreatorRequestId (string) –

        A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional.

        If used, this parameter must contain 1 to 50 alphanumeric or ‘-_.’ characters.

      • LastExecutionDate (datetime) –

        The last time this backup plan was run. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

      • AdvancedBackupSettings (list) –

        Contains a list of BackupOptions for a resource type.

        • (dict) –

          The backup options for each resource type.

          • ResourceType (string) –

            Specifies an object containing resource type and backup options. The only supported resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service (VSS). For a CloudFormation example, see the sample CloudFormation template to enable Windows VSS in the Backup User Guide.

            Valid values: EC2.

          • BackupOptions (dict) –

            Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.

            Valid values:

            Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

            Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

            If you specify an invalid option, you get an InvalidParameterValueException exception.

            For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup.

            • (string) –

              • (string) –