GreengrassV2 / Paginator / ListCoreDevices

ListCoreDevices#

class GreengrassV2.Paginator.ListCoreDevices#
paginator = client.get_paginator('list_core_devices')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from GreengrassV2.Client.list_core_devices().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    thingGroupArn='string',
    status='HEALTHY'|'UNHEALTHY',
    runtime='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • thingGroupArn (string) – 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.

  • status (string) –

    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.

  • runtime (string) –

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

    • aws_nucleus_classic

    • aws_nucleus_lite

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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

      A token to resume pagination.