bulk_deployment_detailed_reports

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

Overview

Name	bulk_deployment_detailed_reports
Type	Resource
Id	aws.greengrass.bulk_deployment_detailed_reports

Fields

The following fields are returned by SELECT queries:

list_bulk_deployment_detailed_reports

Name	Datatype	Description
created_at	string	The time, in ISO format, when the deployment was created.
deployment_arn	string	The ARN of the group deployment.
deployment_id	string	The ID of the group deployment.
deployment_status	string	The current status of the group 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	Details about the error.
error_message	string	The error message for a failed deployment
group_arn	string	The ARN of the Greengrass group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_bulk_deployment_detailed_reports	select	bulk_deployment_id, region	MaxResults, NextToken	Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment 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
bulk_deployment_id	string	The ID of the bulk deployment.
region	string	AWS region (default: us-east-1)
MaxResults	string	The maximum number of results to be returned per request.
NextToken	string	The token for the next set of results, or ''null'' if there are no additional results.

SELECT examples

list_bulk_deployment_detailed_reports

Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.

SELECT
created_at,
deployment_arn,
deployment_id,
deployment_status,
deployment_type,
error_details,
error_message,
group_arn
FROM aws.greengrass.bulk_deployment_detailed_reports
WHERE bulk_deployment_id = '{{ bulk_deployment_id }}' -- required
AND region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;