get_thing_runtime_configuration

get_thing_runtime_configuration(**kwargs)

Get the runtime configuration of a thing.

See also: AWS API Documentation

Request Syntax

response = client.get_thing_runtime_configuration(
    ThingName='string'
)
Parameters
ThingName (string) -- [REQUIRED] The thing name.
Return type
dict
Returns
Response Syntax
{
    'RuntimeConfiguration': {
        'TelemetryConfiguration': {
            'ConfigurationSyncStatus': 'InSync'|'OutOfSync',
            'Telemetry': 'On'|'Off'
        }
    }
}

Response Structure

  • (dict) -- Success. The response contains the runtime configuration for the given thing.
    • RuntimeConfiguration (dict) -- Runtime configuration for a thing.
      • TelemetryConfiguration (dict) -- 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.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException
  • Greengrass.Client.exceptions.InternalServerErrorException