AWS Backup
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListRecoveryPointsByBackupVault

Returns detailed information about the recovery points stored in a backup vault.

Request Syntax

GET /backup-vaults/backupVaultName/recovery-points/?backupPlanId=ByBackupPlanId&createdAfter=ByCreatedAfter&createdBefore=ByCreatedBefore&maxResults=MaxResults&nextToken=NextToken&resourceArn=ByResourceArn&resourceType=ByResourceType HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

backupVaultName

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 AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

ByBackupPlanId

Returns only recovery points that match the specified backup plan ID.

ByCreatedAfter

Returns only recovery points that were created after the specified timestamp.

ByCreatedBefore

Returns only recovery points that were created before the specified timestamp.

ByResourceArn

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

ByResourceType

Returns only recovery points that match the specified resource type.

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

MaxResults

The maximum number of items to be returned.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RecoveryPoints": [ { "BackupSizeInBytes": number, "BackupVaultArn": "string", "BackupVaultName": "string", "CalculatedLifecycle": { "DeleteAt": number, "MoveToColdStorageAt": number }, "CompletionDate": number, "CreatedBy": { "BackupPlanArn": "string", "BackupPlanId": "string", "BackupPlanVersion": "string", "BackupRuleId": "string" }, "CreationDate": number, "EncryptionKeyArn": "string", "IamRoleArn": "string", "IsEncrypted": boolean, "LastRestoreTime": number, "Lifecycle": { "DeleteAfterDays": number, "MoveToColdStorageAfterDays": number }, "RecoveryPointArn": "string", "ResourceArn": "string", "ResourceType": "string", "Status": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

Type: String

RecoveryPoints

An array of objects that contain detailed information about recovery points saved in a backup vault.

Type: Array of RecoveryPointByBackupVault objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: