AWS Backup

{'RecoveryPoints': {'BackupVaultName': 'string',
                    'ResourceArn': 'string',
                    'ResourceType': 'string'}}

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

See also: AWS API Documentation

Request Syntax

client.list_recovery_points_by_legal_hold(
    LegalHoldId='string',
    NextToken='string',
    MaxResults=123
)

type LegalHoldId:

string

param LegalHoldId:

[REQUIRED]

This is the ID of the legal hold.

type NextToken:

string

param NextToken:

This is the next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

type MaxResults:

integer

param MaxResults:

This is the maximum number of resource list items to be returned.

rtype:

dict

returns:

Response Syntax

{
    'RecoveryPoints': [
        {
            'RecoveryPointArn': 'string',
            'ResourceArn': 'string',
            'ResourceType': 'string',
            'BackupVaultName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • RecoveryPoints (list) --

    This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.

    • (dict) --

      This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

      • RecoveryPointArn (string) --

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

      • ResourceArn (string) --

        This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.

      • ResourceType (string) --

        This is the Amazon Web Services resource type that is saved as a recovery point.

      • BackupVaultName (string) --

        This is the name of the backup vault (the logical container in which backups are stored).

  • NextToken (string) --

    This return is the next item following a partial list of returned resources.