recovery_points_by_legal_holds

Creates, updates, deletes, gets or lists a recovery_points_by_legal_holds resource.

Overview

Name	recovery_points_by_legal_holds
Type	Resource
Id	aws.backup.recovery_points_by_legal_holds

Fields

The following fields are returned by SELECT queries:

list_recovery_points_by_legal_hold

Name	Datatype	Description
backup_vault_name	string	The name of the backup vault (the logical container in which backups are stored). (pattern: <code>^[a-zA-Z0-9-_]{2,50}$</code>)
recovery_point_arn	string	The Amazon Resource Name (ARN) of the parent (composite) recovery point.
resource_arn	string	The Amazon Resource Name (ARN) that uniquely identifies a saved resource.
resource_type	string	The Amazon Web Services resource type that is saved as a recovery point. (pattern: <code>^[a-zA-Z0-9-_.]{1,50}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_recovery_points_by_legal_hold	select	legal_hold_id, region	nextToken, maxResults	This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
legal_hold_id	string	The ID of the legal hold.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of resource list items to be returned.
nextToken	string	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.

SELECT examples

list_recovery_points_by_legal_hold

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

SELECT
backup_vault_name,
recovery_point_arn,
resource_arn,
resource_type
FROM aws.backup.recovery_points_by_legal_holds
WHERE legal_hold_id = '{{ legal_hold_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;