execution_previews

Creates, updates, deletes, gets or lists an execution_previews resource.

Overview

Name	execution_previews
Type	Resource
Id	aws.ssm.execution_previews

Fields

The following fields are returned by SELECT queries:

get_execution_preview

Name	Datatype	Description
ended_at	string (date-time)	A UTC timestamp indicating when the execution preview operation ended.
execution_preview	object	Information about the changes that would be made if an execution were run.
execution_preview_id	string	The generated ID for the existing execution preview. (pattern: <code>[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}</code>)
status	string	The current status of the execution preview operation. (Pending, InProgress, Success, Failed)
status_message	string	Supplemental information about the current status of the execution preview.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_execution_preview	select	region		Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

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_execution_preview

Initiates the process of retrieving an existing preview that shows the effects that running a specified Automation runbook would have on the targeted resources.

SELECT
ended_at,
execution_preview,
execution_preview_id,
status,
status_message
FROM aws.ssm.execution_previews
WHERE region = '{{ region }}' -- required
;