AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/things/ThingName/runtimeconfig
GET
GET /greengrass/things/{ThingName}/runtimeconfig
Operation ID: GetThingRuntimeConfiguration
Produces: application/json
CLI
aws greengrass get-thing-runtime-configuration \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
Responses
- 200
-
200 response
GetThingRuntimeConfigurationResponse
{ "RuntimeConfiguration": { "TelemetryConfiguration": { "Telemetry": "On|Off", "ConfigurationSyncStatus": "InSync|OutOfSync" } } }- GetThingRuntimeConfigurationResponse
-
The runtime configuration for a thing.
type: object
- RuntimeConfiguration
-
Runtime configuration for a thing.
type: object
- TelemetryConfiguration
-
The configuration setting for running telemetry.
type: object
required: ["Telemetry"]
- Telemetry
-
The configuration setting to turn on or turn off telemetry.
type: string
enum: ["On", "Off"]
- ConfigurationSyncStatus
-
The synchronization status of the device-reported configuration with the desired configuration.
type: string
enum: ["InSync", "OutOfSync"]
- 400
-
400 response
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- 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
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- 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
PUT
PUT /greengrass/things/{ThingName}/runtimeconfig
Operation ID: UpdateThingRuntimeConfiguration
Produces: application/json
CLI
aws greengrass update-thing-runtime-configuration \ [--telemetry-configuration <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"TelemetryConfiguration": {
"Telemetry": "On|Off"
}
}Responses
- 200
-
200 response
{ }- Empty Schema
-
Empty
type: object
- 400
-
400 response
{ "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
{ "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
