effective_deployments

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

Overview

Name	effective_deployments
Type	Resource
Id	aws.greengrassv2.effective_deployments

Fields

The following fields are returned by SELECT queries:

list_effective_deployments

Name	Datatype	Description
core_device_execution_status	string	The status of the deployment job on the Greengrass core device. IN_PROGRESS – The deployment job is running. QUEUED – The deployment job is in the job queue and waiting to run. FAILED – The deployment failed. For more information, see the statusDetails field. COMPLETED – The deployment to an IoT thing was completed successfully. TIMED_OUT – The deployment didn't complete in the allotted time. CANCELED – The deployment was canceled by the user. REJECTED – The deployment was rejected. For more information, see the statusDetails field. SUCCEEDED – The deployment to an IoT thing group was completed successfully. (IN_PROGRESS, QUEUED, FAILED, COMPLETED, TIMED_OUT, CANCELED, REJECTED, SUCCEEDED)
creation_timestamp	string (date-time)	The time at which the deployment was created, expressed in ISO 8601 format.
deployment_id	string	The ID of the deployment.
deployment_name	string	The name of the deployment.
description	string	The description of the deployment job.
iot_job_arn	string	The ARN of the IoT job that applies the deployment to target devices. (pattern: <code>arn:[^:]*:iot:[^:]+:[0-9]+:job/.+</code>)
iot_job_id	string	The ID of the IoT job that applies the deployment to target devices.
modified_timestamp	string (date-time)	The time at which the deployment job was last modified, expressed in ISO 8601 format.
reason	string	The reason code for the update, if the job was updated.
status_details	object	The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.
target_arn	string	The ARN of the target IoT thing or thing group. (pattern: <code>arn:[^:]:iot:[^:]:[0-9]+:(thing|thinggroup)/.+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_effective_deployments	select	core_device_thing_name, region	maxResults, nextToken	Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

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
core_device_thing_name	string	The name of the core device. This is also the name of the IoT thing.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be returned per paginated request.
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

list_effective_deployments

Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.

SELECT
core_device_execution_status,
creation_timestamp,
deployment_id,
deployment_name,
description,
iot_job_arn,
iot_job_id,
modified_timestamp,
reason,
status_details,
target_arn
FROM aws.greengrassv2.effective_deployments
WHERE core_device_thing_name = '{{ core_device_thing_name }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;