Backup / Paginator / ListRecoveryPointsByResource

ListRecoveryPointsByResource

class Backup.Paginator.ListRecoveryPointsByResource

paginator = client.get_paginator('list_recovery_points_by_resource')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceArn='string',
    ManagedByAWSBackupOnly=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceArn (string) –

  [REQUIRED]

  An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

• ManagedByAWSBackupOnly (boolean) –

  This attribute filters recovery points based on ownership.

  If this is set to TRUE, the response will contain recovery points associated with the selected resources that are managed by Backup.

  If this is set to FALSE, the response will contain all recovery points associated with the selected resource.

  Type: Boolean

• 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

{
    'RecoveryPoints': [
        {
            'RecoveryPointArn': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'Status': 'COMPLETED'|'PARTIAL'|'DELETING'|'EXPIRED',
            'StatusMessage': 'string',
            'EncryptionKeyArn': 'string',
            'BackupSizeBytes': 123,
            'BackupVaultName': 'string',
            'IsParent': True|False,
            'ParentRecoveryPointArn': 'string',
            'ResourceName': 'string',
            'VaultType': 'BACKUP_VAULT'|'LOGICALLY_AIR_GAPPED_BACKUP_VAULT',
            'IndexStatus': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING',
            'IndexStatusMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • RecoveryPoints (list) –

    An array of objects that contain detailed information about recovery points of the specified resource type.

    Note

    Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.

    • (dict) –

      Contains detailed information about a saved recovery point.

      • RecoveryPointArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

      • CreationDate (datetime) –

        The date and time a recovery point 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.

      • Status (string) –

        A status code specifying the state of the recovery point.

      • StatusMessage (string) –

        A message explaining the current status of the recovery point.

      • EncryptionKeyArn (string) –

        The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • BackupSizeBytes (integer) –

        The size, in bytes, of a backup.

      • BackupVaultName (string) –

        The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

      • IsParent (boolean) –

        This is a boolean value indicating this is a parent (composite) recovery point.

      • ParentRecoveryPointArn (string) –

        The Amazon Resource Name (ARN) of the parent (composite) recovery point.

      • ResourceName (string) –

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

      • VaultType (string) –

        The type of vault in which the described recovery point is stored.

      • IndexStatus (string) –

        This is the current status for the backup index associated with the specified recovery point.

        Statuses are: PENDING | ACTIVE | FAILED | DELETING

        A recovery point with an index that has the status of ACTIVE can be included in a search.

      • IndexStatusMessage (string) –

        A string in the form of a detailed message explaining the status of a backup index associated with the recovery point.