recovery_plan_executions

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

Overview

Name	recovery_plan_executions
Type	Resource
Id	aws.drs.recovery_plan_executions

Fields

The following fields are returned by SELECT queries:

get_recovery_plan_execution

Name	Datatype	Description
completed_at	string	The timestamp when the execution completed. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
error_detail	object	Error details if the execution failed.
mode	string	The execution mode. (DRILL, RECOVERY)
recovery_plan_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
recovery_plan_execution_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
started_at	string	The timestamp when the execution started. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
status	string	The execution status. (CREATED, IN_PROGRESS, COMPLETED, FAILED, CANCELLING, CANCELLED)
tags	object	The tags associated with the Recovery Plan execution.

list_recovery_plan_executions

Name	Datatype	Description
error_detail	object	Error details if the execution failed.
mode	string	The execution mode. (DRILL, RECOVERY)
recovery_plan_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
recovery_plan_execution_arn	string	Strict ARN type for Recovery Plan resources. Only allows safe characters in the resource portion — rejects HTML/script injection characters (<, >, ", ', etc.) per AWS API input validation standards. Resource portion allows: [A-Za-z0-9_/.-] which covers all DRS recovery plan resource identifiers (plan-xxx, st-xxx, exec-xxx, step-xxx). (pattern: <code>arn:aws(-[a-z0-9]+)*:drs:[a-z0-9-]+:[0-9]{12}:[a-zA-Z0-9_/.-]+</code>)
started_at	string	The timestamp when the execution started. (pattern: <code>[1-9][0-9]*-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](.[0-9]+)?Z</code>)
status	string	The status of a Recovery Plan execution. (CREATED, IN_PROGRESS, COMPLETED, FAILED, CANCELLING, CANCELLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recovery_plan_execution	select	region		Gets the details of a Recovery Plan execution.
list_recovery_plan_executions	select	region		Lists executions of Recovery Plans, optionally filtered by plan or status.
delete_recovery_plan_execution	delete	region		Deletes a Recovery Plan execution record. Must be in a terminal status.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_recovery_plan_execution

Gets the details of a Recovery Plan execution.

SELECT
completed_at,
error_detail,
mode,
recovery_plan_arn,
recovery_plan_execution_arn,
started_at,
status,
tags
FROM aws.drs.recovery_plan_executions
WHERE region = '{{ region }}' -- required
;

list_recovery_plan_executions

Lists executions of Recovery Plans, optionally filtered by plan or status.

SELECT
error_detail,
mode,
recovery_plan_arn,
recovery_plan_execution_arn,
started_at,
status
FROM aws.drs.recovery_plan_executions
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_recovery_plan_execution

Deletes a Recovery Plan execution record. Must be in a terminal status.

DELETE FROM aws.drs.recovery_plan_executions
WHERE region = '{{ region }}' --required
;