UpdateThingRuntimeConfiguration - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

You are viewing the documentation for Amazon IoT Greengrass Version 1. Amazon IoT Greengrass Version 2 is the latest major version of Amazon IoT Greengrass. For more information about the Amazon IoT Greengrass V2 API, see the Amazon IoT Greengrass Version 2 API Reference.

UpdateThingRuntimeConfiguration

Updates the runtime configuration of a Greengrass core to turn on or turn off telemetry.

URI: PUT /greengrass/things/{ThingName}/runtimeconfig

produces: application/json

CLI:

aws greengrass update-thing-runtime-configuration \ --thing-name <value> \ [--telemetry-configuration <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "TelemetryConfiguration": { "Telemetry": "On|Off" }, "ThingName": "" }

Parameters:

RuntimeConfigurationUpdateRequestBody

The configuration settings to run telemetry.

where used: body; required: true

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

schema:

RuntimeConfigurationUpdate

Information about the runtime configuration for a thing.

type: object

TelemetryConfiguration

The configuration settings to run telemetry.

type: object

required: ["Telemetry"]

Telemetry

The configuration setting to turn on or turn off telemetry.

type: string

enum: ["On", "Off"]

ThingName

The thing name.

where used: path; required: true

type: string

Responses:

200

200 response

Empty

{ }
Empty Schema

Empty

type: object

400

400 response

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

Message

A message that contains information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

500

500 response

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

Message

A message that contains information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string