Backup / Paginator / ListProtectedResourcesByBackupVault

ListProtectedResourcesByBackupVault

class Backup.Paginator.ListProtectedResourcesByBackupVault

paginator = client.get_paginator('list_protected_resources_by_backup_vault')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• BackupVaultName (string) –

  [REQUIRED]

  This is the list of protected resources by backup vault within the vault(s) you specify by name.

• BackupVaultAccountId (string) – This is the list of protected resources by backup vault within the vault(s) you specify by account ID.

• 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

{
    'Results': [
        {
            'ResourceArn': 'string',
            'ResourceType': 'string',
            'LastBackupTime': datetime(2015, 1, 1),
            'ResourceName': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Results (list) –

    These are the results returned for the request ListProtectedResourcesByBackupVault.

    • (dict) –

      A structure that contains information about a backed-up resource.

      • ResourceArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

      • ResourceType (string) –

        The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is Amazon EC2.

      • LastBackupTime (datetime) –

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

      • ResourceName (string) –

        This is the non-unique name of the resource that belongs to the specified backup.