AWS IoT Greengrass V2

{'runtime': 'string'}

Retrieves metadata for a Greengrass core device.

See also: AWS API Documentation

Request Syntax

client.get_core_device(
    coreDeviceThingName='string'
)

type coreDeviceThingName:

string

param coreDeviceThingName:

[REQUIRED]

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

rtype:

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

{'runtime': 'string'}

{'coreDevices': {'architecture': 'string',
                 'platform': 'string',
                 'runtime': 'string'}}

Retrieves a paginated list of Greengrass core devices.

See also: AWS API Documentation

Request Syntax

client.list_core_devices(
    thingGroupArn='string',
    status='HEALTHY'|'UNHEALTHY',
    maxResults=123,
    nextToken='string',
    runtime='string'
)

type thingGroupArn:

string

param thingGroupArn:

The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.

type status:

string

param status:

The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:

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

type maxResults:

integer

param maxResults:

The maximum number of results to be returned per paginated request.

type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

type runtime:

string

param runtime:

The runtime to be used by the core device. The runtime can be:

• aws_nucleus_classic

• aws_nucleus_lite

rtype:

dict

returns:

Response Syntax

{
    'coreDevices': [
        {
            'coreDeviceThingName': 'string',
            'status': 'HEALTHY'|'UNHEALTHY',
            'lastStatusUpdateTimestamp': datetime(2015, 1, 1),
            'platform': 'string',
            'architecture': 'string',
            'runtime': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • coreDevices (list) --

    A list that summarizes each core device.

    • (dict) --

      Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.

      • coreDeviceThingName (string) --

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

      • status (string) --

        The status of the core device. Core devices can have the following statuses:

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

      • 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

  • nextToken (string) --

    The token for the next set of results, or null if there are no additional results.