core_devices

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

Overview

Name	core_devices
Type	Resource
Id	aws.greengrassv2.core_devices

Fields

The following fields are returned by SELECT queries:

get_core_device

Name	Datatype	Description
architecture	string	The computer architecture of the core device.
core_device_thing_name	string	The name of the core device. This is also the name of the IoT thing.
core_version	string	The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
last_status_update_timestamp	string (date-time)	The time at which the core device's status last updated, expressed in ISO 8601 format.
platform	string	The operating system platform that the core device runs.
runtime	string	The runtime for the core device. The runtime can be: aws_nucleus_classic aws_nucleus_lite
status	string	The status of the core device. The core device status can be: HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue. UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device. (HEALTHY, UNHEALTHY)
tags	object	A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

list_core_devices

Name	Datatype	Description
architecture	string	The computer architecture of the core device.
core_device_thing_name	string	The name of the core device. This is also the name of the IoT thing.
last_status_update_timestamp	string (date-time)	The time at which the core device's status last updated, expressed in ISO 8601 format.
platform	string	The operating system platform that the core device runs.
runtime	string	The runtime for the core device. The runtime can be: aws_nucleus_classic aws_nucleus_lite
status	string	The status of the core device. Core devices can have the following statuses: HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue. UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device. (HEALTHY, UNHEALTHY)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_core_device	select	core_device_thing_name, region		Retrieves metadata for a Greengrass core device. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud When the status of any component on the core device becomes BROKEN At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
list_core_devices	select	region	thingGroupArn, status, maxResults, nextToken, runtime	Retrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud For Greengrass nucleus 2.12.2 and earlier, the core device sends status updates when the status of any component on the core device becomes ERRORED or BROKEN. For Greengrass nucleus 2.12.3 and later, the core device sends status updates when the status of any component on the core device becomes ERRORED, BROKEN, RUNNING, or FINISHED. At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment
delete_core_device	delete	core_device_thing_name, region		Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.

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.
runtime	string	The runtime to be used by the core device. The runtime can be: aws_nucleus_classic aws_nucleus_lite
status	string	The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options: HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue. UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.
thingGroupArn	string	The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.

SELECT examples

get_core_device

Retrieves metadata for a Greengrass core device. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud When the status of any component on the core device becomes BROKEN At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

SELECT
architecture,
core_device_thing_name,
core_version,
last_status_update_timestamp,
platform,
runtime,
status,
tags
FROM aws.greengrassv2.core_devices
WHERE core_device_thing_name = '{{ core_device_thing_name }}' -- required
AND region = '{{ region }}' -- required
;

list_core_devices

Retrieves a paginated list of Greengrass core devices. IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn't running on the device, or if device isn't connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated. Core devices send status updates at the following times: When the IoT Greengrass Core software starts When the core device receives a deployment from the Amazon Web Services Cloud For Greengrass nucleus 2.12.2 and earlier, the core device sends status updates when the status of any component on the core device becomes ERRORED or BROKEN. For Greengrass nucleus 2.12.3 and later, the core device sends status updates when the status of any component on the core device becomes ERRORED, BROKEN, RUNNING, or FINISHED. At a regular interval that you can configure, which defaults to 24 hours For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

SELECT
architecture,
core_device_thing_name,
last_status_update_timestamp,
platform,
runtime,
status
FROM aws.greengrassv2.core_devices
WHERE region = '{{ region }}' -- required
AND thingGroupArn = '{{ thingGroupArn }}'
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND runtime = '{{ runtime }}'
;

DELETE examples

delete_core_device

Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see DeleteThing in the IoT API Reference.

DELETE FROM aws.greengrassv2.core_devices
WHERE core_device_thing_name = '{{ core_device_thing_name }}' --required
AND region = '{{ region }}' --required
;