ListCoreDevices - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Retrieves a paginated list of Greengrass core devices.


Amazon IoT Greengrass relies on individual devices to send status updates to the Amazon Web Services Cloud. If the Amazon 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 Amazon 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 Amazon IoT Greengrass Core v2.7.0, the core device sends status updates upon local deployment and cloud deployment

Request Syntax

GET /greengrass/v2/coreDevices?maxResults=maxResults&nextToken=nextToken&status=status&thingGroupArn=thingGroupArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


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

Valid Range: Minimum value of 1. Maximum value of 100.


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


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 Amazon IoT Greengrass Core software and all components run on the core device without issue.

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



The ARN of the Amazon 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.

Pattern: arn:[^:]*:iot:[^:]*:[0-9]+:thinggroup/.+

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "coreDevices": [ { "coreDeviceThingName": "string", "lastStatusUpdateTimestamp": number, "status": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A list that summarizes each core device.

Type: Array of CoreDevice objects


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

Type: String


For information about the errors that are common to all actions, see Common Errors.


You don't have permission to perform the action.

HTTP Status Code: 403


Amazon IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500


Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

HTTP Status Code: 429


The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: