deployment_status

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

Overview

Name	deployment_status
Type	Resource
Id	aws.greengrass.deployment_status

Fields

The following fields are returned by SELECT queries:

get_deployment_status

Name	Datatype	Description
deployment_status	string	The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
deployment_type	string	The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid. (NewDeployment, Redeployment, ResetDeployment, ForceResetDeployment)
error_details	array	Error details
error_message	string	Error message
updated_at	string	The time, in milliseconds since the epoch, when the deployment status was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_status	select	deployment_id, group_id, region		Returns the status of a deployment.

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
deployment_id	string	The ID of the deployment.
group_id	string	The ID of the Greengrass group.
region	string	AWS region (default: us-east-1)

SELECT examples

get_deployment_status

Returns the status of a deployment.

SELECT
deployment_status,
deployment_type,
error_details,
error_message,
updated_at
FROM aws.greengrass.deployment_status
WHERE deployment_id = '{{ deployment_id }}' -- required
AND group_id = '{{ group_id }}' -- required
AND region = '{{ region }}' -- required
;