update-thing-runtime-configuration¶

Description¶

Updates the runtime configuration of a thing.

Synopsis¶

  update-thing-runtime-configuration
[--telemetry-configuration <value>]
--thing-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--telemetry-configuration (structure) Configuration for telemetry service.Telemetry -> (string)

Configure telemetry to be on or off.

Shorthand Syntax:

Telemetry=string

JSON Syntax:

{
  "Telemetry": "On"|"Off"
}

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

Examples¶

To turn on telemetry in the runtime configuration of a Greengrass core

The following update-thing-runtime-configuration example updates the runtime configuration of a Greengrass core to turn on telemetry.

aws greengrass update-thing-runtime-configuration \
    --thing-name SampleGreengrassCore \
    --telemetry-configuration {\"Telemetry\":\"On\"}

This command produces no output.

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

Output¶

None

Table of Contents

Feedback

User Guide