Backup / Paginator / ListBackupAccessPointsByRecoveryPoint

ListBackupAccessPointsByRecoveryPoint

class Backup.Paginator.ListBackupAccessPointsByRecoveryPoint

paginator = client.get_paginator('list_backup_access_points_by_recovery_point')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• RecoveryPointArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the recovery point whose backup access points you want to list.

• 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

{
    'BackupAccessPoints': [
        {
            'AccessPointArn': 'string',
            'AccessPointMetadata': {
                'string': 'string'
            },
            'BackupVaultArn': 'string',
            'BackupVaultName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'Name': 'string',
            'RecoveryPointArn': 'string',
            'ResourceArn': 'string',
            'ResourceType': 'string',
            'Status': 'AVAILABLE'|'CREATING'|'DELETING'|'DISASSOCIATED'|'DISASSOCIATING'|'EXPIRED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • BackupAccessPoints (list) –

    A list of backup access points, each containing metadata such as its name, ARN, status, and associated recovery point.

    • (dict) –

      Contains metadata about a backup access point.

      • AccessPointArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the backup access point.

      • AccessPointMetadata (dict) –

        Metadata for the backup access point. After the backup access point reaches the AVAILABLE status, this map contains S3AccessPointArn and S3AccessPointAlias, which you use with standard Amazon S3 read APIs to access the backup data. For continuous recovery points, this map also contains AccessPointInTime (in format 2021-11-27T03:30:27Z). The access point provides access to the content present in the backup at that specific time.

        • (string) –

          • (string) –

      • BackupVaultArn (string) –

        The Amazon Resource Name (ARN) of the backup vault that contains the recovery point.

      • BackupVaultName (string) –

        The name of the backup vault that contains the recovery point.

      • CreationTime (datetime) –

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

      • Name (string) –

        The name of the backup access point.

      • RecoveryPointArn (string) –

        The Amazon Resource Name (ARN) of the recovery point that the backup access point provides access to.

      • ResourceArn (string) –

        The Amazon Resource Name (ARN) of the resource that was backed up, such as an Amazon S3 bucket.

      • ResourceType (string) –

        The type of Amazon Web Services resource associated with the recovery point. For example, S3 for Amazon Simple Storage Service.

      • Status (string) –

        The current status of the backup access point.

      • StatusMessage (string) –

        A message that provides additional detail about the status of the backup access point, such as the reason a creation or deletion attempt failed.