get-core-device¶

Description¶

Retrieves metadata for a Greengrass core device.

Note

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

Synopsis¶

  get-core-device
--core-device-thing-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--core-device-thing-name (string)

The name of the core device. This is also the name of the IoT thing.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get a core device

The following get-core-device example gets information about an AWS IoT Greengrass core device.

aws greengrassv2 get-core-device \
    --core-device-thing-name MyGreengrassCore

Output:

{
    "coreDeviceThingName": "MyGreengrassCore",
    "coreVersion": "2.0.3",
    "platform": "linux",
    "architecture": "amd64",
    "status": "HEALTHY",
    "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00",
    "tags": {}
}

For more information, see Check core device status in the AWS IoT Greengrass V2 Developer Guide.

Output¶

coreDeviceThingName -> (string)

The name of the core device. This is also the name of the IoT thing.

coreVersion -> (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 .

platform -> (string)

The operating system platform that the core device runs.

architecture -> (string)

The computer architecture of the core device.

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.

lastStatusUpdateTimestamp -> (timestamp)

The time at which the core device’s status last updated, expressed in ISO 8601 format.

tags -> (map)

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 .

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide