[ aws . greengrass ]



Get the runtime configuration of a thing.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


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


--thing-name (string) The thing name.

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

See ‘aws help’ for descriptions of global parameters.


To retrieve the runtime configuration of a Greengrass core

The following get-thing-runtime-configuration example retrieves the runtime configuration of a Greengrass core. Before you can retrieve the runtime configuration, you must use the update-thing-runtime-configuration command to create a runtime configuration for the core.

aws greengrass get-thing-runtime-configuration \
    --thing-name SampleGreengrassCore


    "RuntimeConfiguration": {
        "TelemetryConfiguration": {
            "ConfigurationSyncStatus": "OutOfSync",
            "Telemetry": "On"

For more information, see Configuring telemetry settings in the AWS IoT Greengrass Developer Guide.


RuntimeConfiguration -> (structure)

Runtime configuration for a thing.

TelemetryConfiguration -> (structure)

Configuration for telemetry service.

ConfigurationSyncStatus -> (string)

Synchronization status of the device reported configuration with the desired configuration.

Telemetry -> (string)

Configure telemetry to be on or off.