bulk_deployment_status

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

Overview

Name	bulk_deployment_status
Type	Resource
Id	aws.greengrass.bulk_deployment_status

Fields

The following fields are returned by SELECT queries:

get_bulk_deployment_status

Name	Datatype	Description
bulk_deployment_metrics	object	Relevant metrics on input records processed during bulk deployment.
bulk_deployment_status	string	The status of the bulk deployment. (Initializing, Running, Completed, Stopping, Stopped, Failed)
created_at	string	The time, in ISO format, when the deployment was created.
error_details	array	Error details
error_message	string	Error message
tags	object	Tag(s) attached to the resource arn.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_bulk_deployment_status	select	bulk_deployment_id, region		Returns the status of a bulk 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
bulk_deployment_id	string	The ID of the bulk deployment.
region	string	AWS region (default: us-east-1)

SELECT examples

get_bulk_deployment_status

Returns the status of a bulk deployment.

SELECT
bulk_deployment_metrics,
bulk_deployment_status,
created_at,
error_details,
error_message,
tags
FROM aws.greengrass.bulk_deployment_status
WHERE bulk_deployment_id = '{{ bulk_deployment_id }}' -- required
AND region = '{{ region }}' -- required
;