GreengrassV2 / Client / get_core_device

get_core_device#

GreengrassV2.Client.get_core_device(**kwargs)#

Retrieves metadata for a Greengrass core device.

Note

IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the IoT Greengrass Core software isn’t running on the device, or if device isn’t connected to the Amazon Web Services Cloud, then the reported status of that device might not reflect its current status. The status timestamp indicates when the device status was last updated.

Core devices send status updates at the following times:

  • When the IoT Greengrass Core software starts

  • When the core device receives a deployment from the Amazon Web Services Cloud

  • When the status of any component on the core device becomes BROKEN

  • At a regular interval that you can configure, which defaults to 24 hours

  • For IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

See also: AWS API Documentation

Request Syntax

response = client.get_core_device(
    coreDeviceThingName='string'
)
Parameters:

coreDeviceThingName (string) –

[REQUIRED]

The name of the core device. This is also the name of the IoT thing.

Return type:

dict

Returns:

Response Syntax

{
    'coreDeviceThingName': 'string',
    'coreVersion': 'string',
    'platform': 'string',
    'architecture': 'string',
    'runtime': 'string',
    'status': 'HEALTHY'|'UNHEALTHY',
    'lastStatusUpdateTimestamp': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • coreDeviceThingName (string) –

      The name of the core device. This is also the name of the IoT thing.

    • coreVersion (string) –

      The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.

    • platform (string) –

      The operating system platform that the core device runs.

    • architecture (string) –

      The computer architecture of the core device.

    • runtime (string) –

      The runtime for the core device. The runtime can be:

      • aws_nucleus_classic

      • aws_nucleus_lite

    • status (string) –

      The status of the core device. The core device status can be:

      • HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.

      • UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state on the core device.

    • lastStatusUpdateTimestamp (datetime) –

      The time at which the core device’s status last updated, expressed in ISO 8601 format.

    • tags (dict) –

      A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.

      • (string) –

        • (string) –

Exceptions

  • GreengrassV2.Client.exceptions.ValidationException

  • GreengrassV2.Client.exceptions.ResourceNotFoundException

  • GreengrassV2.Client.exceptions.AccessDeniedException

  • GreengrassV2.Client.exceptions.InternalServerException

  • GreengrassV2.Client.exceptions.ThrottlingException